数据/文件夹R包中.Rdata文件中的两个R对象？

编程问答 2022-08-16

问题描述

我正在通过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 (将#修改为@）

devtoolsrrrdroxygen2