Question

我正在编写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中）。我在这里缺少什么？

Answer 1

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

R CMD Rd2pdf mypackage

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

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

Answer 2

R CMD check创建目录PACKAGE.RCheck。在此目录中，您可以找到文件PACKAGE-manual.pdf。

Answer 3

我有同样的问题。看来，当您单击构建或签入Rstudio（使用devtools时）时，默认参数为＆＃39; - no-manual＆＃39;被添加到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

检查期间还检查输出中的任何错误。可能存在可能导致文档崩溃的字符。

Answer 4

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

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

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

4 个答案: