R 使用 R CMD 检查创建参考手册答案

【问题标题】：R create reference manual with R CMD checkR 使用 R CMD 检查创建参考手册
【发布时间】：2013-06-03 21:32:40
【问题描述】：

我正在编写一个 R 包，并想为包中的所有功能制作一份 pdf 参考手册。我从here 了解到R CMD check 会自动创建参考手册。

Here我读到“您在 NAMESPACE 的导出部分中列出的函数”创建了一个手动条目。

我的 NAMESPACE 文件如下所示：

# Export all names
exportPattern(".")

# Import all packages listed as Imports or Depends
import(
  LIM
)

所以我认为一切都会被导出。在包目录上的R CMD check 期间，最后它说：

 * checking PDF version of manual ... OK

但是，我在我的包目录中找不到参考手册（我假设它在 inst/doc 中）。我在这里错过了什么？

【问题讨论】：

标签： r package reference-manual

【解决方案1】：

另一种方法是直接使用以下方法创建参考手册：

R CMD Rd2pdf mypackage

其中mypackage 是包含您的R 包代码文件夹结构的文件夹，包括带有.Rd 文件的man 文件夹。

由于某种原因，我在构建或签入 RStudio 期间从未获得参考手册，可能是因为我错过了某处的设置。但是像这样运行命令也可以正常工作。

【讨论】：

刚试过，效果很好！感谢您指出Rd2pdf！
同上的问题，感谢您的建议解决了。我真的不明白为什么 Rstudio 搞得这么乱。
虽然这很有用，但它有一个不尊重 .Rbuildignore 的特性 (?)

【解决方案2】：

R CMD check 创建一个目录PACKAGE.RCheck。在这个目录中你可以找到文件PACKAGE-manual.pdf。

【讨论】：

PACKAGE-manual.pdf 位于包目录上方的一个文件夹中，../package.Rcheck。

【解决方案3】：

我有同样的问题。似乎当您单击 Rstudio 中的 Build 或 Check 时（使用 devtools 时），默认情况下，“--no-manual”参数会添加到 R CMD 选项中。

我通过在 R 命令提示符中手动提供参数解决了这个问题：

library(devtools)

check(cleanup = FALSE,manual = TRUE,path = getwd())

# without running the examples
check(cleanup = FALSE,args = c('--no-examples'),manual = TRUE,path = getwd())

在这种情况下，名为 package.Rcheck 的文件夹将包含手册作为 package-manual.pdf

在检查期间还要检查输出中的任何错误。可能有一些字符可能会使文档崩溃。

【讨论】：

查看 RStudio 首选项以轻松更改此设置

【解决方案4】：

另一种解决方法是使用以下方法生成它：

build_manual(path=getwd())
#or
check(manual = TRUE, args="--output=~/folder/subfolder")

【讨论】：