Как документировать наборы данных для r-пакета? - PullRequest
2 голосов
/ 20 июня 2020

Я пытаюсь документировать наборы данных для r-пакета, как здесь http://r-pkgs.had.co.nz/data.html#documenting -data . Все данные состоят из отдельных векторов, и я написал в каждом data1.R что-то вроде этого:

#'
#' @format A single vector with one column:
#' @examples
#' \dontrun{
#'  data1
#' }
"data1"

Их, я поместил каждый файл документа с расширением «.R» в папку mypackage/R. Но когда я отправил запрос CRAN, они сообщили следующее предупреждение:

Undocumented code objects:
  ‘data1’ ‘data2’ ‘data3’ ‘data4’ ‘data5’ ‘data6’
Undocumented data sets:
  ‘data1’ ‘data2’ ‘data3’ ‘data4’ ‘data5’ ‘data6’

Что я сделал не так?

1 Ответ

2 голосов
/ 20 июня 2020

Все объекты пакета должны быть задокументированы, чтобы избежать предупреждений. Вы должны запустить:

devtools::document(roclets = c('rd', 'collate', 'namespace'))

для создания файлов .Rd, связанных с вашими наборами данных

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...