在R中记录通用的S3方法,以便用户可以看到文档?

时间:2019-06-17 12:05:17

标签: r documentation roxygen2 r-s3

我正在通过方法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 = ""){
...
}

现在,该函数仅作为通用函数导出,这很好,并且可以正常工作。

但是用户如何查看这些功能的文档?

我可以以这种方式制作文档,以便用户可以直观地找到它们吗?

0 个答案:

没有答案
相关问题