roxygen2和RStudio无法为函数创建文档

Question

我正在尝试通过roxygen2在软件包中添加文档。 我能够成功创建软件包，并在加载时使用函数。 这是我的操作方式，我在RStudio上创建一个空的R软件包项目，然后有一个名为“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

此外，还有NAMESPACE文件，导出模式为“^[[:alpha:]]+”。我认为我可能缺少一些重要的步骤。

- Avinash

---

你已经配置了RStudio项目以“使用Roxygen生成文档”吗？ - Roland

@Roland 是的，我有。目前，在构建软件包之前运行 oxygenize("包名") 就可以正常工作了。但我在想它也应该可以以其他方式工作。 - Avinash

当您配置使用roxygen生成文档时，是否单击“配置”并设置“运行时自动应用roxygen：”字段？ - Oliver Keyes

@OliverKeyes 是的，就是这样。谢谢。 - Avinash

@Avinash 收到，我会把它添加为答案。 - Oliver Keyes

Answer 1

在RStudio中，启用roxygen2时，默认情况下会在软件包构建和R CMD CHECK上应用roxygenise，但不会在“构建和重新加载”时应用。要启用该功能，请进入项目选项->构建工具。然后点击“使用Roxygen生成文档”的“配置”按钮，并选择“生成和重新加载”框。

- Oliver Keyes

Answer 2

有时候，RStudio根本不会显示“使用Roxygen生成文档”的复选框。如果出现这种情况，请在R Console中键入library(roxygen2)，然后它就会突然出现。

我希望默认情况下强制加载并启用它。

- userJT

Answer 3

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

- rsoren