如何解决如何在RStudio中为R包构建API文档?
我正在开发一个最新的Windows 10版本RStudio 1.3.959,并且我刚刚安装了最新的MikTex。
我正在尝试使用RStudio将R包放在一起。我可以构建该软件包,并且将功能文档注释转换为/man/*.Rd文件。当在RStudio控制台窗口中执行?function_name时,这些内容便会成功显示。
不幸的是,我在构建PDF包API文档方面运气不佳(不要误认为是小插图;我可以自己构建)。我看了很多教程,但是它们都没能指导人们如何构建每个R软件包都期望的最终PDF API文档。
我尝试过:
构建[Windows]->更多->文档 ...,该文件执行devtools::document(roclets = c('rd','collate','namespace','vignette'))
构建[Windows]->更多->构建源软件包 ...,该软件包先执行devtools::document(roclets = c('rd','vignette'))
,然后执行devtools::build(binary = TRUE,args = c('--preclean'))
构建[Windows]->更多->构建二进制包 ...,该文件先执行devtools::document(roclets = c('rd',args = c('--preclean'))
所有这三个功能均符合预期,但最终包装手册pdf文件仍然没有。
在堆栈上进行一些挖掘,我发现有人使用了以下命令:
devtools::build_manual()
我确信这是我所需要的。但是,当我执行那行代码时,我得到了错误:
Converting Rd files to LaTeX ...
Warning in sys2(makeindex,shQuote(idxfile)) : '"makeindex"' not found
Error in texi2dvi(file = file,pdf = TRUE,clean = clean,quiet = quiet,:
unable to run 'makeindex' on 'Rd2.idx'
Warning in sys2(makeindex,:
unable to run 'makeindex' on 'Rd2.idx'
Error in running tools::texi2pdf()
Error: Failed to build manual
这让我没有一个更明智的选择,尽管很明显,缺少makeindex会使我有些不高兴。非常感谢您的帮助。
解决方法
如果我理解正确,则表示标准参考手册。例如ggplot2 reference manual。以我的经验,当您提交时,这是由CRAN一起提出的。 (据我所知,所有手册都是一本文件齐全的文件的集合),例如DESCRIPTION文件,NAMESPACE文件以及用于实际文件的各种.RD文件。
即使在公开场合github for ggplot2,我们也会看到他们的资料库中没有该手册。此外,他们的addOrder() {
this.ordersFromArray.push(this.createOrder())
}
文件中没有任何证据表明他们自己编写了手册。
但是,如果您想自己做.git*ignore
是正确的函数调用。
我能够使用github上预先存在的软件包制作手册。我建议尝试重新安装您的devtools::build_manual()
软件包,并确保没有警告或错误。以管理员身份运行会话以确保正确安装可能会有所帮助。
祝你好运!
我在MacOS High Serra上使用带有RStudio 1.1.453的R版本3.4。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。