在脚本之间共享roxygen2条目

Question

我目前正在开发一个包含多个算法的包，用于执行相同的操作（极端概率估计btw）。在这个范围内，很多函数共享相同的输入，并以相同的方式处理它们。

有没有办法避免将每个字段从文件复制/粘贴到另一个字段（例如@note @references ...）？或者我应该在哪里写这些共享功能？

感谢

Answer 1

有两种选择：

1. 如果这些功能在逻辑上属于同一个帮助页面，则可以通过在除一个条目之外的所有条目上设置@rdname来对这些功能进行分组：

   #' Description
   #' @param x this is an interesting argument
   foo = function (x) x * 2
   
   #' @rdname foo
   bar = function (x) x * 3
   

2. 您可以使用@inheritParams“继承”另一个函数的文档块中的一个函数的参数。

   #' Description
   #' @param x this is an interesting argument
   foo = function (x) x * 2
   
   #' Description
   #' @inheritParams foo
   bar = function (x) x * 3