递归文档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的特定于操作系统的子目录。