生成包文档文件

Question

我正在使用devtools整合R包。似乎CRAN上的大多数软件包都有一个文档文件，涵盖了所有记录的函数。我如何建立这个？

我有pkgname.R，就像这样：

#' _PACKAGE
#' @encoding utf-8
#'
#' @title Show where Adam bought the beer.
#'
#' @description The package consists of diverse functions to analyse
#' the path between Adam and the beer.
#'
#' @author Rolf Marvin Bøe Lindgren <rolf@grendel.no>
#' @docType package
#' @name Tarnation
#' 
#' 
"_PACKAGE"
#> [1] "_PACKAGE"
#'

这会生成一个很好的帮助文件。

我认为生成全面的文档文件既有简单的方法，也有繁琐的方法。非常感谢指向相关文档的指针。

Answer 1

R CMD check <packagename>

在<packagename>.Rcheck

中生成它