Документирование общих методов S3 в R, чтобы пользователь мог видеть документацию? - PullRequest
Новая
       80

Документирование общих методов S3 в R, чтобы пользователь мог видеть документацию?

0 голосов
/ 17 июня 2019

Я расширяю функцию print() методом print.dmdSchemeSet().У этой функции есть дополнительные аргументы, которые я, очевидно, задокументировал в исходных файлах, используя roxygen2: 

#' Generic print function for \code{dmdSchemeSet}
#'
#' @param x object of type \code{dmdSchemeSet}
#' @param ... additional arguments - not used here
#' @param printAttr default \code{TRUE} - attributes are printed
#' @param printExtAttr default \code{FALSE} - additional attributes are not printed (e.g. \code{class})
#' @param printData default \code{TRUE} - data is printed
#' @param .prefix mainly for internal use - prefix for all printed lines
#'
#' @return invisibly x
#' @export
#'
print.dmdSchemeSet <- function(x, ..., printAttr = TRUE, printExtAttr = FALSE, printData = TRUE, .prefix = ""){
...
}

Теперь функция экспортируется только как универсальная функция, и это нормально, и она работает.

Но как пользователь может просматривать документацию по этим функциям?

Могу ли я сделать документацию таким образом, чтобы пользователь мог ее интуитивно найти?

...