阻止@family创建S3方法的链接

时间:2014-08-21 21:53:01

标签: r devtools roxygen2

使用" roxygen2"我使用@family将一堆S3泛型函数(每个函数都有一些方法)组合在一起。在生成的Rd文件中,“另请参阅”部分不仅包含通用函数的链接,还包含所有已定义方法的链接。

有没有办法控制此行为,以便不创建方法链接?

请参阅我在此处开发的软件包https://github.com/mbojan/isnar。例如,请参阅coleman.R https://github.com/mbojan/isnar/blob/master/R/coleman.Rassort.R https://github.com/mbojan/isnar/blob/master/R/assort.R以及man目录中生成的Rd文件。

正如您将看到的,通用函数(例如coleman)及其方法(例如coleman.igraphcoleman.table等)记录在同一文件中(使用{{1 }})。解决问题的一种方法是将文档拆分为通用和单个方法等的单独文件,并将@rdname仅放在具有泛型函数的文件中。但是,我真的不希望这样做,因为我想将通用及其方法的源代码保存在同一个文件中,并将所有这些源代码记录在同一个Rd文件中。

0 个答案:

没有答案