R Language
roxygen2

Parametry

Dokumentowanie paczki za pomocą roxygen2

Pisanie za pomocą roxygen2

roxygen2 to pakiet stworzony przez Hadley Wickham w celu ułatwienia dokumentacji.

Pozwala na dołączenie dokumentacji do skryptu R, w wierszach zaczynających się od #' . Różne parametry przekazane do dokumentacji zaczynają się od @ , na przykład twórca pakietu zapisuje w następujący sposób:

#' @author The Author

Na przykład, jeśli chcemy udokumentować następującą funkcję:

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

Będziemy chcieli napisać krótki opis tej funkcji i wyjaśnić parametry w następujący sposób (każda linia zostanie wyjaśniona i wyszczególniona później):

#' 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)

• Pierwszy wiersz #' Mean to tytuł dokumentacji, kolejne wiersze tworzą korpus.
• Każdy parametr funkcji musi być wyszczególniony poprzez odpowiedni @param . @export wskazał, że nazwa tej funkcji powinna zostać wyeksportowana, a zatem można ją wywołać po załadowaniu pakietu.
• @keyword słowo kluczowe zapewnia trafne słowa kluczowe podczas szukania pomocy
• @importFrom wyświetla listę wszystkich funkcji do zaimportowania z pakietu, który będzie używany w tej funkcji lub w twoim pakiecie. Pamiętaj, że importowanie pełnej przestrzeni nazw pakietu można wykonać za pomocą @import
• Przykłady są następnie zapisywane poniżej znacznika @example .
  • Pierwszy zostanie oceniony podczas budowania pakietu;
  • Drugi nie - zwykle w celu uniknięcia długich obliczeń - z powodu polecenia \dontrun .

Budowanie dokumentacji

Dokumentację można utworzyć za pomocą devtools::document() . Zauważ też, że devtools::check() automatycznie utworzy dokumentację i zgłosi brakujące argumenty w dokumentacji funkcji jako ostrzeżenia.