logo标签列表

有没有一种自动更新R包文档的方法？

rpackagemanualroxygen
7
我几个月前使用'package.skeleton()'生成.Rd帮助文件。我已经编辑了这些文件，还更改了函数，删除了一些函数，添加了其他函数。是否有一种函数可以自动更新Rd文件？
更新
最近发布了一个不错的软件包Rd2roxygen，作者Yihui Xie在他的blog中描述了它。正如其名称所示，该软件包允许将当前包含在.Rd中的文档反向插入到.R文件中。听起来像是一种有前途的方法，既可以学习roxygen，也可以将当前正在开发的包转换为R包。谢谢Yihui！
基于Joshua和Yihui的答案，答案似乎是：根据源.R代码中的更改，roxygen允许自动更新Rd文件等；如果我目前没有使用roxygen，则Rd2roxygen可以帮助我迁移。
3个回答
11

Rd2roxygen旨在帮助那些陷入原始Rd文件但想转向roxygen的包开发者 - 它可以处理Rd文件并使用roxygen注释更新R脚本。从那时起，您就可以开始享受roxygen的威力了。因此，Rd2roxygen并不是直接的解决方案，但它可能会帮助您进行过渡。

9

这并不是针对你的问题的具体答案，但你可能会对Roxygen感兴趣。

这不是一个特定于你问题的答案，但你可能会对Roxygen感兴趣。
Roxygen相对于“编写R扩展”的工具有哪些优势？ - David LeBauer
主要是基于您添加到源.R文件的额外信息为您创建.Rd文件。 - Joshua Ulrich
4
一项非常重要的优点是它使得你在编写代码后立即编写文档变得容易——你甚至不需要切换文件。这样，不仅重要细节在你脑海中仍然新鲜，而且你可以在“哇嗷！编写新代码！”阶段编写文档，而不是在生产的“呃...必须回去记录所有东西”的阶段。 - Sharpie
1

不，我不这么认为。

但你可以尝试重新运行package.skeleton()来获取新的或更改过的函数，然后手动合并它们。

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接