roxygen2仅用于记录R包或R项目吗?

时间:2016-08-17 14:27:51

标签: r documentation-generation roxygen2

我对"roxygen2"包有疑问:

我看过很多教程都将它用于包文档(例如Hadley Wickham的主要"object documentation"页面)

那么如果我的R代码不是一个包,比如一个R项目呢? 您是否可以使用roxygen2记录R项目?

我仍然可以运行 package.skeleton(name='RoxygenSkeleton', code_files = "Roxygen.R", force=TRUE)函数用于创建基本包结构,并创建.Rd文件。但我希望HTML或PDF中有一个很好的输出......

1 个答案:

答案 0 :(得分:2)

Roxygen仅适用于包装,按设计(my suggestion to change this被彻底拒绝)。你当然可以把你的项目变成一个包,有些人建议这样做。

我设法让roxygen2在我的modules之外的包之外工作,但这是一个痛苦的问题,并且需要调用未导出的API(你不应该这样做)。