42

我正在编写一个 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 中）。我在这里想念什么？

4

4 回答 4

84

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

R CMD Rd2pdf mypackage

mypackage包含 R 包代码文件夹结构的文件夹在哪里，包括带有man.Rd 文件的文件夹。

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

于 2014-03-10T23:48:22.433 回答
25

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

于 2013-06-07T15:30:25.353 回答
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

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

于 2016-12-14T14:47:44.317 回答
1

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

build_manual(path=getwd())
#or
check(manual = TRUE, args="--output=~/folder/subfolder")
于 2019-08-18T17:43:03.197 回答