roxygen2 /如何只有一个帮助页面的S4通用及其方法？

尽管在话题与各种计算器的答案试验和阅读支持文档的： http://r-pkgs.had.co.nz/man.html roxygen2 /如何只有一个帮助页面的S4通用及其方法？

我还没有能够创建一个包帮助页面将包含一个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) { 
[email protected]}) 

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

这仍然显示RStudio作为两个单独的帮助页面都具有相同内容：

我想只有一个帮助页面：“plotCMDS泛型函数用于绘制古典多维尺度”包括通用及其两种方法。

来源

2016-07-07 user2968765

\ @describeIn的替代方法是\ @rdname。它覆盖roxygen生成的默认文件名，并将多个对象的文档合并到一个文件中。这使您可以根据自己的需要完全自由地组合文档。来自：http://r-pkgs.had.co.nz/man.html#text-formatting，只是在类似的东西上挠头。希望这可以帮助。转义只是表明rdname不是SOF用户名 – Chris

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

来源

2016-07-10 04:44:52 user2968765

roxygen2 /如何只有一个帮助页面的S4通用及其方法？

回答

相关问题