簡體   English   中英

roxygen2 和 RStudio,不為函數創建文檔

[英]roxygen2 and RStudio, not creating the documentation for the functions

我正在嘗試通過 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:]]+"

我想我錯過了一些重要的步驟。

當您啟用 roxygen2 時,RStudio 中的默認設置是對包構建和 R CMD CHECK 上的所有內容進行 roxygenise,但不在“構建和重新加載”上。 要啟用它,請轉到項目選項 -> 構建工具。 然后單擊“使用 Roxygen 生成文檔”旁邊的“配置”按鈕並勾選“構建和重新加載”框。

有時 RStudio 根本不會顯示“使用 Roxygen 生成文檔”復選框。 如果是這種情況,在 R Console 類型庫(roxygen2)中,它會突然出現。

我希望默認是強制加載並啟用它。

我在使用devtools制作軟件包時遇到了同樣的問題。 我只需要運行devtools::document()來創建幫助文件。

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM