[英]Is there a way to document few datasets in the same R file when compiling documentation with roxygen2 package in R?
我想知道是否有可能在R中的文档中为1个以上的数据集提供1个帮助页面? 我想知道在这种情况下@alias
是否可行?
我或多或少希望记录3个这样的数据集
#'
#' title
#'
#' description
#'
#' @source \url{url}
#' @alias
"data1"
"data2"
"data3"
编辑
解决方案是使用相同的@rdname和@name,如下所示:
#' @name clinical
#' @rdname clinical
#' @aliases ACC.clinical,BLCA.clinical,BRCA.clinical,CESC.clinical,CHOL.clinical,COAD.clinical,COADREAD.clinical,DLBC.clinical,ESCA.clinical,FPPP.clinical,GBM.clinical,GBMLGG.clinical,HNSC.clinical,KICH.clinical,KIPAN.clinical,KIRC.clinical,KIRP.clinical,LAML.clinical,LGG.clinical,LIHC.clinical,LUAD.clinical,LUSC.clinical,MESO.clinical,OV.clinical,PAAD.clinical,PCPG.clinical,READ.clinical,SKCM.clinical,STAD.clinical,STES.clinical,TGCT.clinical,THCA.clinical,THYM.clinical,UCEC.clinical,UCS.clinical,UVM.clinical
#'
"ACC.clinical"
#' @name clinical
#' @rdname clinical
#' @format NULL
#'
"BRCA.clinical"
#' @name clinical
#' @rdname clinical
#' @format NULL
#'
"BLCA.clinical"
#' @name clinical
#' @rdname clinical
#' @format NULL
#'
...
尽管我还没有做到,但应该有可能。 尝试阅读此http://cran.r-project.org/doc/manuals/r-release/R-exts.html#Documenting-data-sets 。
在这种情况下,别名应该是可能的。
解决方案是使用相同的@rdname和@name,如下所示:
#' @name clinical
#' @rdname clinical
#' @aliases ACC.clinical,BLCA.clinical,BRCA.clinical,CESC.clinical,CHOL.clinical,COAD.clinical,COADREAD.clinical,DLBC.clinical,ESCA.clinical,FPPP.clinical,GBM.clinical,GBMLGG.clinical,HNSC.clinical,KICH.clinical,KIPAN.clinical,KIRC.clinical,KIRP.clinical,LAML.clinical,LGG.clinical,LIHC.clinical,LUAD.clinical,LUSC.clinical,MESO.clinical,OV.clinical,PAAD.clinical,PCPG.clinical,READ.clinical,SKCM.clinical,STAD.clinical,STES.clinical,TGCT.clinical,THCA.clinical,THYM.clinical,UCEC.clinical,UCS.clinical,UVM.clinical
#'
"ACC.clinical"
#' @name clinical
#' @rdname clinical
#' @format NULL
#'
"BRCA.clinical"
#' @name clinical
#' @rdname clinical
#' @format NULL
#'
"BLCA.clinical"
#' @name clinical
#' @rdname clinical
#' @format NULL
#'
...
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.