2016-02-12 3 views
2

У меня есть файлы данных, которые я хочу распространять с помощью пакета, который я создаю. Я поместил файлы в inst/extdata. Как и где я могу документировать эти файлы с помощью roxygen2?R и roxygen2: Как документировать файлы данных в inst/extdata?

+0

http://r-pkgs.had.co.nz/data.html –

+0

Нет ничего, что я могу видеть о том, как документировать необработанные данные. Я внимательно следил за книгой R Packages во время разработки, поэтому, конечно, я читал эту страницу :) – L42

+0

точно так же, как вы делаете данные в '/ data', за исключением того, что он ссылается на' @name raw_data1' и Значение 'NULL' вместо' "raw_data1" ' – rawr

ответ

0

Я до сих пор не уверен, что это лучшая практика, но по совету rawr «s это то, что я сделал:

  • Созданный файл R/extdata.R
  • Документально каждый файл я имею в инст/extdata, как это:

(Игнорировать эту строку:. Видимо, мне нужно какой-нибудь текст здесь, так что то, что ниже превращается в блоке кода)

#' Dataset foo 
#' 
#' This is a dataset containing stuff. 
#' 
#' @name raw_datasetName 
#' 
#' @section datasetName.csv: 
#' 
#' This data is used in thisFunction(). 
NULL 

 Смежные вопросы

  • Нет связанных вопросов^_^