roxygen2 /如何只为S4泛型及其方法提供一个帮助页面?

时间:2016-07-07 06:06:11

标签: r s4 roxygen2

尽管在主题和阅读支持文档上尝试了各种stackoverflow答案: http://r-pkgs.had.co.nz/man.html

我仍然无法创建一个包含S4通用函数及其所有方法的包帮助页面作为一个且只有一个帮助页面。

#' generic function for plotting classical multidimensional scaling
#' @param object (ReportClass or RunClass)
#' @rdname plotCMDS
#' @export

setGeneric("plotCMDS", function(object) {
standardGeneric("plotCMDS")})

#' @rdname plotCMDS
#' @export
setMethod("plotCMDS", signature(object = "ReportClass"), function(object) {
object@cdms})

#' @rdname plotCMDS
#' @export
setMethod("plotCMDS", signature(object = "RunClass"), function(object) {
listcmds <- lapply(object@reports, function(x) slot(x, "cmds"))
listcmds <- lapply(listcmds, `[[`, 1)
do.call(gridExtra::grid.arrange,  listcmds)})

这仍然在RStudio中显示为两个具有相同的帮助页面 内容: enter image description here

我想只有一个帮助页面:“plotCMDS泛函用于绘制经典的多维缩放”,包括泛型和它的两种方法。

1 个答案:

答案 0 :(得分:0)

我的错误。如上所述,帮助页面在pdf文件中正确呈现。只是pdf文件和RStudio GUI以不同的方式呈现帮助页面。