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

Question

我正在编写R包,并希望制作包中所有功能的pdf参考手册.我从这里了解到R CMD check自动创建参考手册.

在这里,我读到"在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是包含包括您ř包代码的文件夹结构的文件夹man与.Rd文件的文件夹.

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

Answer 2

R CMD check创建一个目录PACKAGE.RCheck.在此目录中,您可以找到该文件PACKAGE-manual.pdf.