遞歸文檔R包

Question

我正在嘗試使用RStudio構建我的第一個軟件包。

我已經有一個帶有R文件的項目，而我只是這樣更改了項目布局：

.
|-R
|---File
|---Physics
|---Plot
|---Utils
|-man
|-vignettes
|-DESCRIPTION
|-NAMESPACE

我的DESCRIPTION文件包含以下文本：

Package: my-package
Title: Package title
Version: 0.0.0.9000
Authors@R: person("Ben",
  "Me",
  email = "my@email.com",
  role = c("aut", "cre"))
Description: blabla
Depends:
    R (>= 3.3.2)
License: file LICENSE
Encoding: UTF-8
LazyData: true
VignetteBuilder: knitr
Suggests:
    knitr,
    rmarkdown
RoxygenNote: 5.0.1

我所有的功能都包含roxygen注釋。 當我在RStudio中使用Build / Document函數時，它說：

==> devtools::document(roclets=c('rd', 'collate', 'namespace', 'vignette'))

Updating my-package documentation
Loading my-package
Writing NAMESPACE
Updating vignettes
Documentation completed

但是手冊頁和NAMESPACE文件保持為空。

如果我生成並重新加載該項目，則No man pages found in package消息中No man pages found in package 。

所以我猜Document命令沒有正確應用。 如果我將帶有注釋的R腳本直接放在R文件夾的根目錄下，它將找到它。 有沒有辦法讓RStudio遞歸瀏覽我的所有代碼文件夾，還是我應該將我的所有文件放在R文件夾的根目錄下（這對於來自Java世界的人來說很麻煩...）？

Answer 1

R文檔指出僅允許以下文件夾（並且它們具有自己的功能）：

man子目錄可能包含一個名為macros的子目錄； 這將包含用戶定義的Rd宏的源。 （請參閱用戶定義的宏。）這些宏使用Rd格式，但除了宏定義，注釋和空格外，可能不包含任何其他內容。

R和man子目錄可能包含名為unix或windows的特定於操作系統的子目錄。