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

还有NAMESPACE文件,

exportPattern( "^ [[:阿尔法:]] +"

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

Answer 1

当您启用roxygen2时,RStudio中的默认值是对包构建和R CMD CHECK上的所有内容进行roxygenise,而不是"构建和重新加载".要启用它,请转到项目选项 - >构建工具.然后单击"使用Roxygen生成文档"旁边的"配置"按钮,并勾选"构建和重新加载"框.