r语言 - roxygen2 和 RStudio，而不是为函数创建文档

Question

我正在尝试通过 roxygen2 在包中添加文档。我能够成功创建 packag，并且在加载时也可以使用这些函数。以下是我对如何做到这一点的理解，我在 RStudio 上创建了一个空的 R-Package 项目，然后有一个名为"getSomething.R"的源文件。内容如下，

#' Test function to ask on stackoverflow
#' 
#' code{getSomething} Does something to get something.
#' 
#' @param a param 1
#' @param b param 2
#' 
#'
getSomething <- function(a,b){
  return(a*b)
}

现在，我构建并加载了包，理想情况下，它应该使用 ./man 文件夹中的 rd 文件，并且还会出现"？getSomething"。但是使用该命令时没有任何结果，也没有创建 Rd 文件。我在这里错过了什么吗？在我的原始项目中，我添加了一些依赖包。

以下是描述文件，

Package: testPackage
Type: Package
Title: Learn how to use roxygen2.
Version: 1.0.1
Date: 2014-11-27
Author: amj2403
Maintainer: amj2403 <emailid>
Description: Write something here
License: NA
Depends:
    R (>= 3.0.0),
    rjson,
    futile.logger,
    RCurl

还有命名空间文件，

exportPattern（"^[[：alpha：]]+"

我想我错过了一些重要的步骤。

Answer 1

当您启用 roxygen2 时，RStudio 中的默认设置是重新充氧软件包构建和 R CMD CHECK 上的所有内容，而不是"构建和重新加载"上的所有内容。若要启用此功能，请转到"项目选项"-">"生成工具"。然后单击"使用 Roxygen 生成文档"旁边的"配置"按钮，并勾选"构建和重新加载"框。

Answer 2

有时 RStudio 根本不会显示"使用 Roxygen 生成文档"复选框。如果是这种情况，在 R 控制台类型库 （roxygen2） 中，它会突然出现。

我希望默认是强制加载并启用它。

Answer 3

我在用devtools制作软件包时遇到了同样的问题。我只需要运行devtools::document()来创建帮助文件。