R 使用 R CMD 检查创建参考手册 [英] R create reference manual with R CMD check

问题描述

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

I am writing an R package and would like to make a pdf reference manual of all functions in the package. I understood from here that R CMD check automatically creates a reference manual.

这里 我读到创建了一个手动条目"您在 NAMESPACE 的导出部分中列出的函数.

Here I read that a manual entry is created "of the functions you listed in the export section of NAMESPACE".

我的 NAMESPACE 文件如下所示:

My NAMESPACE file looks as follows:

# Export all names
exportPattern(".")

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

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

so I thought everything will be exported. During R CMD check on the package directory, at the very end it says:

 * checking PDF version of manual ... OK

但是，我在我的包目录中找不到参考手册(我假设它在 inst/doc 中).我在这里错过了什么?

However, I do not find a reference manual in my package directory (I would assume it would be in inst/doc). What am I missing here?

推荐答案

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

R CMD check creates a directory PACKAGE.RCheck. In this directory you could find the file PACKAGE-manual.pdf.

这篇关于R 使用 R CMD 检查创建参考手册的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！