我可以生成没有roxygen2注释的.Rd文件

时间:2016-03-24 05:57:02

标签: r rstudio roxygen2 r-package

是否可以为R函数生成.Rd文件而无需手动编写roxygen注释?

我知道一种方法是使用prompt(),但这不会查看参数或返回值。

可以通过任何其他命令或使用RStudio完成吗?

2 个答案:

答案 0 :(得分:1)

是的,您可以手动编写文件,就像我们大多数人长期做的那样。有关格式的详细信息,请参阅Writing R Extensions

答案 1 :(得分:1)

您可以从中创建要创建包的脚本,然后使用命令

import graphlab
graphlab.path.append(path)

这将基于当前环境中的所有内容创建一个包,因此请确保您的环境仅包含创建包所需的内容。 如果您正在使用devtools(我建议您这样做),请在另一个文件夹外执行此操作。这将创建一个“man”文件夹,其中包含.Rd文件,这些文件可作为您采购的所有内容的基本模板这需要文档。这样可以节省一些时间,而不是手工编写所有时间。

如果您使用的是devtools,请将这些文件复制到项目中的另一个“man”目录中。