有没有办法自动更新R包中的文档?

时间:2010-11-04 18:30:49

标签: r package manual roxygen

几个月前我使用'package.skeleton()'生成.Rd帮助文件。我已经编辑了这些文件,我也更改了功能,删除了一些功能,添加了其他功能。是否有自动更新Rd文件的功能?

更新

刚刚发布了一个名为Rd2roxygen的精美软件包,作者Yihui Xie在他的blog上进行了描述。

顾名思义,该软件包允许用户追溯将当前包含在.Rd中的文档插入到.R文件中。对于学习roxygen和将目前正在开发的软件包转换为R软件包而言,这听起来很有前景。呜呜。谢谢一惠!

根据Joshua和Yihui的回答,答案似乎是: roxygen允许根据源.R代码的变化自动更新Rd文件等,如果我目前不使用roxygen ,Rd2roxygen可以帮助我迁移。

3 个答案:

答案 0 :(得分:10)

Rd2roxygen旨在帮助那些已经“陷入”原始Rd文件但希望切换到roxygen的开发人员 - 它可以处理Rd文件并使用roxygen注释更新R脚本。从那时起,您就可以开始享受roxygen的力量。因此,Rd2roxygen不是直接的答案,但它可能会帮助您完成转换。

答案 1 :(得分:9)

这并不是专门回答您的问题,但您可能对Roxygen感兴趣。

答案 2 :(得分:1)

不,我不这么认为。

但您可以尝试为新功能或已更改的功能重新运行package.skeleton(),然后手动合并。