如何解决数据/文件夹R包中.Rdata文件中的两个R对象?
我正在通过R CMD检查警告,目前正在处理以下警告消息:
* checking for missing documentation entries ... WARNING
Undocumented code objects:
‘diagnoses’
Undocumented data sets:
‘diagnoses’
现在,我的R包框架的data /文件夹中有一个.RData文件,其中包含2个-不仅仅是1个-加载RData内容时加载的R对象。但是,我找不到任何文档可以告诉我如何声明两个R对象,以便在我roxgenise()并执行后续的R CMD检查时,手册页会在此声明。
到目前为止,我正在尝试使用“ @format”标记在数据集手册页中记录两个R对象。我也尝试使用“ @return”标签代替“ @format”标签,但警告仍然存在。 我注意到它就像R对象的名称与RData文件的名称相匹配。因此,未将Miller2015 R对象报告为未记录,但是诊断为data.frame。
#' @title Untargeted metabolomic analysis for the clinical screening of inborn errors
#' of metabolism
#'
#' @description Global metabolic profiling obtained by untargeted mass spectrometry-based
#' metabolomic platform for the detection of novel and known inborn errors of
#' metabolism.
#'
#' @name Miller2015
#' @aliases Miller2015
#' @docType data
#' @usage data(Miller2015)
#' @format Miller2015 - The data frame with 1203 metabolite features as rows,and 186 untargeted metabolomics patient samples as columns,alongside 16 metabolite annotations.
#' @format diagnoses - A data.frame where all patient IDs are mapped to their given biochemical diagnosis.
#' @keywords datasets
#' @references Miller et al. (2015) J Inherit Metab Dis. 2015; 38: 1029–1039
#' (\href{https://www.ncbi.nlm.nih.gov/pmc/articles/PMC4626538/}{PubMed})
#' @source \href{https://www.ncbi.nlm.nih.gov/pmc/articles/PMC4626538/bin/10545_2015_9843_MOESM1_ESM.xls}{Dataset}
#'
#' @examples
#' require(CTD)
#' data(Miller2015)
"Miller2015"
如何解决此警告而不必将R对象分解为单独的RData文件?什么是最佳做法?
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。