Должна ли документация набора данных иметь то же имя, что и файл в use_data_raw в R pakcages?

Question

Документация для набора данных должна быть включена в каталог R в виде файла .R. Каталог data-raw также содержит файлы .R. Должны ли они быть названы точно так же?

Answer 1

R-файлам не нужно одинаковое имя.Файл документации R (сохраненный в папке R) всегда называется data.R.В файле data.R вы можете задокументировать 1 или более наборов данных.В приведенном ниже коде документирован фрейм данных с именем trial

#' Results from a simulated trial of Placebo vs Drug
#'
#' A dataset containing the baseline characteristics of 200 patients
#' randomized to Placebo or Drug.  Dataset also contains the trial outcome:
#' tumor response to the treatment.
#'
#' @format A data frame with 200 rows--one row per patient
#' \describe{
#'     \item{trt}{Treatment Randomization}
#'     \item{age}{Age, yrs}
#'     \item{marker}{Marker Level, ng/mL}
#'     \item{stage}{T Stage}
#'     \item{grade}{Grade}
#'     \item{response}{Tumor Response}
#'     \item{death}{Patient Died}
#'     \item{ttdeath}{Months to Death/Censor}
#' }
"trial"

Именованный набор данных trial должен совместно использоваться файлом trial.rda, сохраненным в папке data.