在一个文件中自动记录多个S3方法

时间:2011-07-27 12:37:56

标签: r documentation rd

由于最初运行package.skeleton来创建包,我添加了几个S3类。这些类中的每一个都有5-10种方法。我发现了从加载到内存中的函数创建.Rd文件的精彩prompt命令,但是是否可以让R自动创建一个记录了所有多个函数的帮助文件?我正在考虑像prompt的增强版本,你会传递一个函数列表,它会创建一个.Rd文件,只有附加信息添加到帮助文件。

例如,如果我有一个名为duration的泛型,以及有方法duration.bond(market,...)duration.account(market,time,...)duration.portfolio(market,...)的类,我希望{{1}使用prompt部分创建一个包含\usage\method{}部分的\arguments{}market { {1}}。

这里有什么希望吗?复制和粘贴变得非常累人!

2 个答案:

答案 0 :(得分:1)

为了完整性,添加我在这里选择的内容,即选择具有最多参数的方法并使用提示,然后手动将其他方法添加到同一帮助文件中。

另一种选择是使用Rd2roxygen将已经存在于.Rd中的所有内容转换回Roxygen,然后将Roxygen用于整个项目。这可能就是我在下一个版本中所做的。

答案 1 :(得分:0)

您可以通过阅读模板帮助文件(使用readLines)自行滚动,然后对其进行编辑以适应每个特定情况(明智地使用pastegsub) ,然后将结果写回文件(通过writeLines)。