Включите пример использования данных в документацию этих данных (при разработке пакета R)

Можно ли включить в документацию данных в пакете R (с использованием Roxygen через Rstudio) пример, в котором используются эти данные?

Например. TestPackage.R в каталоге R

#' My New Colour
#' 
#' Enables use of my new colour \emph{aNewColour} in plots.
#' @name aNewColour
#' @docType data
#' @format A colour defined by rgb(red=232,green=81,blue=0,maxColorValue=255)
#' @usage data(allNewColours)
#' @examples
#' curve(dnorm,from=-4,to=4,col=aNewColour,lwd=2)
NULL

В том же каталоге R у меня есть файл allNewColours.rda, который состоит только из переменной aNewColour со значением #E85100.

Когда я нажимаю Проверить в меню Сборка R studio (эквивалентно команде R CMD Check, я полагаю), я получаю следующее сообщение об ошибке :

** Примеры

кривая (dnorm, from = -4, to = 4, col = aNewColour, lwd = 2) Ошибка в plot.xy (xy, type, ...): объект 'aNewColour' не найден Вызовы: кривая -> график -> plot.default -> plot.xy Выполнение остановлено Ошибка: Ошибка команды (1) Выполнение остановлено

Вышел со статусом 1.

Можно ли использовать данные "aNewColour" в примере документации "aNewColour"?

Изменить: Хорошо, я нашел свою проблему. Если я перемещу файл .rda в папку данных (на том же уровне, что и папка R, все работает)... Долго боролся с этим только для того, чтобы определить решение в течение нескольких секунд после публикации этого вопроса...


person user1420372    schedule 27.06.2014    source источник
comment
См. Редактировать для решения проблемы. Теперь это работает. Мне нужно было, чтобы мой файл .rda находился в каталоге данных на том же уровне, что и каталог R.   -  person user1420372    schedule 27.06.2014
comment
Также следует отметить, что для этого примера требуется LazyData: yes в файле DESCRIPTION, иначе работать не будет.   -  person user1420372    schedule 27.06.2014
comment
Ответьте как официальный ответ и отметьте правильный   -  person Tyler Rinker    schedule 27.06.2014
comment
Кстати, с roxygen2 теперь вы можете документировать "aNewColour", и он заполнит имя и т. Д. Правильными значениями.   -  person hadley    schedule 28.06.2014


Ответы (1)


переместите файл .rda в папку данных и введите LazyData: yes в файле DESCRIPTION.

person user1420372    schedule 29.06.2014