R Language
roxygen2

параметры

Документирование пакета с помощью roxygen2

Запись с помощью roxygen2

roxygen2 - это пакет, созданный Хэдли Уикхэмом для облегчения документирования.

Он позволяет включать документацию внутри R-скрипта в строки, начинающиеся с #' . Различные параметры, переданные в документацию, начинаются с @ , например, создатель пакета будет написан следующим образом:

#' @author The Author

Например, если мы хотим записать следующую функцию:

mean<-function(x) sum(x)/length(x)

Мы захотим написать небольшое описание этой функции и объяснить параметры следующим образом (каждая строка будет объяснена и подробно описана после):

#' Mean
#'
#' A function to compute the mean of a vector
#' @param x A numeric vector
#' @keyword mean
#' @importFrom base sum
#' @export
#' @examples
#' mean(1:3)
#' \dontrun{ mean(1:1e99) }
mean<-function(x) sum(x)/length(x)

• Первая строка #' Mean - это название документации, следующие строки составляют корпус.
• Каждый параметр функции должен быть детализирован с помощью соответствующего @param . @export указал, что это имя функции должно быть экспортировано и, таким образом, может быть @export при загрузке пакета.
• @keyword предоставляет релевантные ключевые слова при поиске справки
• @importFrom перечисляет все функции для импорта из пакета, который будет использоваться в этой функции или в вашем пакете. Обратите внимание, что импортирование полного пространства имен пакета может быть выполнено с помощью @import
• Затем примеры записываются ниже тега @example .
  • Первый будет оцениваться при создании пакета;
  • Второй не будет - обычно для предотвращения длинных вычислений - из-за команды \dontrun .

Построение документации

Документацию можно создать с помощью devtools::document() . Также обратите внимание, что devtools::check() автоматически создаст документацию и сообщит о недостающих аргументах в документации о функциях в качестве предупреждений.