如何在 RStudio 中为 R 包构建 API 文档？

Question

我正在开发最近的 Windows 10 版本 RStudio 1.3.959，我刚刚安装了最新的 MikTex。

我正在尝试使用 RStudio 组合一个 R 包。我可以构建包，并且函数文档注释正在转换为 /man/*.Rd 文件。然后在 RStudio 控制台 window.

中执行 ?function_name 时成功显示这些

不幸的是，我在构建 PDF 包 API 文档时运气不佳（不要被误认为是小插图；我可以构建它）。我浏览了很多教程，但它们都没有指导人们如何构建每个 R 包所期望的最终 PDF API 文档。

我试过： Build[Windows]->More->Document ... 执行 devtools::document(roclets = c('rd', 'collate', 'namespace', 'vignette'))

Build[Windows]->More->Build Source Package ... 执行 devtools::document(roclets = c('rd', 'collate', 'namespace', 'vignette')) 后跟 devtools::build(binary = TRUE, args = c('--preclean'))

Build[Windows]->More->Build Binary Package ... 执行 devtools::document(roclets = c('rd', 'collate', 'namespace', 'vignette')) 然后 devtools::build(binary = TRUE, args = c('--preclean'))

这三个功能都符合预期，但仍然没有最终包手册 pdf 文件。

在 Stack 上做一些挖掘我注意到有人使用了命令：

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, shQuote(idxfile)) : '"makeindex"' not found
Error in texi2dvi(file = file, pdf = TRUE, clean = clean, quiet = quiet,  : 
  unable to run 'makeindex' on 'Rd2.idx'
Error in running tools::texi2pdf()
Error: Failed to build manual

这让我 none 变得更聪明了，尽管很明显缺少 makeindex 有点令人不安。非常感谢帮助。

Answer 1

如果我没理解错的话，你指的是标准参考手册。例如 ggplot2 reference manual。以我的经验，这是在您提交时由 CRAN 抛出的。所有的手册（据我所知）是一个文档齐全的包应该有的东西的集合，例如 DESCRIPTION 文件、NAMESPACE 文件和用于实际文档的各种 .RD 文件。

即使在查看 public github for ggplot2 时，我们也发现他们的存储库中没有手册。此外，他们的 .git*ignore 文件中没有任何证据表明他们自己制作了手册。

但是，如果您想自己制作 devtools::build_manual() 是正确的函数调用。

我能够使用 github 上已有的软件包制作手册。我建议尝试重新安装 devtools 软件包并确保没有警告或错误。以管理员身份运行会话可能有助于确保正确安装。

祝你好运！

我在 MacOS High Serra 上使用 R 版本 3.4 和 RStudio 1.1.453。

如何在 RStudio 中为 R 包构建 API 文档？

How to build API documentation for an R package in RStudio?

r

rstudio

roxygen2