Описание тега roxygen2

Описание тега Вопросы с тегом
NoneRoxygen2 - это похожая на Doxygen система документации в исходном коде для Rd, сопоставления и NAMESPACE. Его основное использование - документирование функций R в соответствии с определением функции.

roxygen2 похожая на doxygen система документации для пакетов r; позволяя указать в исходном кодеRd директивы файлов, сопоставления и пространства имен.

Стандартный способ написания документации R- создать Rdфайлы (документация R) вman каталог пакета. Rdфайлы - это особый формат файлов, очень похожий на латекс. Их можно преобразовать в различные форматы, включая LaTeX, html и простой текст. Эти файлы описывают каждый объект (функцию, набор данных, класс, универсальный объект или метод).

С участием roxygen2, документация написана в комментариях рядом с каждой функцией. Затем сценарий R используется для создания основных файлов.

пример

#' The length of a string (in characters).
#'
#' @inheritParams str_detect
#' @return numeric vector giving number of characters in each element of the
#' character vector. Missing string have missing length.
#' @keywords character
#' @seealso \code{\link{nchar}} which this function wraps
#' @export
#' @examples
#' str_length(letters)
#' str_length(c("i", "like", "programming", NA))
str_length <- function(string) {
  string <- check_string(string)

  nc <- nchar(string, allowNA = TRUE)
  is.na(nc) <- is.na(string)
  nc
}

Преимущества roxygen2:

  • Код и документация находятся рядом

  • roxygen2динамически осматривает объекты. Например, он может автоматически добавлять ссылки на суперклассы и подклассы.

  • он заботится о других файлах, которые неудобно или совершенно болезненно поддерживать вручную: о пространстве имен, порядке сопоставления в описании и индексе демонстрационных материалов.

  • он абстрагируется от различий в документировании методов, обобщений и классов r-s3 и s4, так что они ведут себя в основном одинаково.

В Rd2roxygen Пакет предоставляет удобный способ преобразования файлов Rd в комментарии roxygen для существующих файлов Rd.

Репозитории

Виньетки

Другие источники

Связанные теги