R创建带有R CMD检查的参考手册

问题描述

我正在编写一个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检查的参考手册的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！