6

我正在尝试通过 roxygen2 在包中添加文档。我能够成功创建包装，并且在加载时也能够使用这些功能。这是我对如何做的理解，我在 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("^[[:alpha:]]+"

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

4

3 回答 3

10

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

于 2014-12-08T13:20:08.947 回答
2

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

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

于 2016-05-17T18:09:18.643 回答
1

我在用devtools. 我只需要运行devtools::document()来创建帮助文件。

于 2020-02-05T19:17:12.667 回答