在R中编译带有roxygen2包的文档时,有没有办法在同一个R文件中记录少数数据集?

时间:2015-05-24 18:00:30

标签: r roxygen2

我想知道是否有可能在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
#' 
...

2 个答案:

答案 0 :(得分:1)

虽然我没有这样做,但应该是可能的。请尝试阅读此http://cran.r-project.org/doc/manuals/r-release/R-exts.html#Documenting-data-sets

在这种情况下,别名应该是可能的。

答案 1 :(得分:1)

解决方案是使用相同的@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
#' 
...