0

我正在通过 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 文件？什么是最佳实践？

4

0 回答 0