Поделиться roxygen2 записей между сценариями

Question

В настоящее время я разрабатываю пакет, содержащий несколько алгоритмов для выполнения одной и той же задачи (оценка экстремальной вероятности кстати). В этой области много функций разделяют одни и те же входы и обрабатывают их одинаково.

Есть ли способ избежать копирования/вставки каждого поля из файла в другой (например, @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