递归文档R包
我正在尝试用RStudio构建我的第一个包 我已经有一个包含R文件的项目,我只是更改了项目布局,如下所示:递归文档R包,r,R,我正在尝试用RStudio构建我的第一个包 我已经有一个包含R文件的项目,我只是更改了项目布局,如下所示: . |-R |---File |---Physics |---Plot |---Utils |-man |-vignettes |-DESCRIPTION |-NAMESPACE 我的说明文件包含以下文本: Package: my-package Title: Package title Version: 0.0.0.9000 Authors@R: person("Ben", "Me
.
|-R
|---File
|---Physics
|---Plot
|---Utils
|-man
|-vignettes
|-DESCRIPTION
|-NAMESPACE
我的说明文件包含以下文本:
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
但是手册页和名称空间文件仍然为空
如果我构建并重新加载项目,我会在包中找到一条无手册页的消息
所以我猜Document命令没有正确应用。如果我将带有注释的R脚本直接放在R文件夹的根目录下,它会找到它。有没有一种方法可以让RStudio递归地浏览我的所有代码文件夹,或者我应该把我的所有文件放在R文件夹的根目录下(这对来自Java世界的人来说很麻烦…?声明只允许以下文件夹(并且有它们自己的功能):
man子目录可以包含一个名为macros的子目录;这将包含用户定义的Rd宏的源代码。(请参阅用户定义的宏。)这些宏使用Rd格式,但可能只包含宏定义、注释和空白
R和man子目录可能包含名为unix或windows的操作系统特定子目录
首先尝试正确的文件夹结构。另外,这不是Rstudio问题。所以正确的文件夹结构是平面结构?好的。那感觉很奇怪。这意味着大型软件包在一个文件夹中有大量文件。维护IMHO并不容易。@Ben您可以自由地为这些文件使用合理的命名方案。例如,查看ggplot2这样的大型软件包是如何实现的: