Куда поместить файлы R, которые генерируют данные пакета

В настоящее время я разрабатываю пакет R и хочу, чтобы он был как можно более чистым, поэтому я пытаюсь разрешить все ПРЕДУПРЕЖДЕНИЯ и ПРИМЕЧАНИЯ, отображаемые devtools::check().

Одно из этих замечаний относится к некоторому коду, который я использую для создания примера данных для пакета:

checking top-level files ... NOTE
Non-standard file/directory found at top level:
  'generate_sample_data.R'

Это R-скрипт, который в настоящее время находится в корневом каталоге пакета и не предназначен для распространения вместе с пакетом (потому что его включение не кажется полезным)

Итак, вот мой вопрос: куда мне поместить такой файл или как мне сказать R оставить его в покое? .Rbuildignore это правильный путь? В настоящее время devtools::build() помещает сценарий R в окончательный пакет, поэтому я не должен просто игнорировать ПРИМЕЧАНИЕ.


r devtools r-package
person AlexR    schedule 03.11.2017    source источник
comment
.Rbuildigore - правильное место   -  person LyzandeR    schedule 03.11.2017
comment
Я использую ./data-raw/ (предложено r-pkgs.had.co.nz/data.html) для сценариев, которые мне нужно сохранить для воспроизводимости (и обновлений), но которые не должны быть доступны конечному пользователю. Как вы предложили, добавьте этот каталог в ./.Rbuildignore, и у вас не должно возникнуть проблем.   -  person r2evans    schedule 03.11.2017
comment
@ r2evans Я искал книгу раньше, но не нашел этого. Для этого в devtools::use_data_raw() есть даже вспомогательная функция, позволяющая все это настроить! Спасибо, что нашли. Если вы превратите это в ответ, я с радостью приму его.   -  person AlexR    schedule 03.11.2017

Ответы (1)


arrow_upward
1
arrow_downward

Как предложено в http://r-pkgs.had.co.nz/data.html имеет смысл использовать ./data-raw/ для скриптов/функций, которые необходимы для создания/обновления данных, но не для того, что вам нужно в самом пакете. После добавления ./data-raw/ к ./.Rbuildignore генерация пакета должна игнорировать все в этом каталоге. (И, как вы прокомментировали, есть вспомогательная функция devtools::use_data_raw().)

person r2evans    schedule 03.11.2017