Add data to r package
- 1. Добавление данных в пакет Экспортируемые и внутренние данные пакета Алексей Селезнёв
- 3. Зачем добавлять в пакет данные • Добавить в пакет данные, которые будут доступны конечному пользователю • Внутренние данные пакета, которые используются исключительно в технических целях, и не доступны пользователям пакета • Добавить примеры необработанных данных • Данные о состоянии работы пакета • Пользовательские данные для работы с пакетом, конфигурация или авторизационные данные
- 4. Экспортируемые данные • Экспортируемые данные хранятся в отдельном каталоге data/ • Добавить в пакет экспортируемые данные можно командой usethis::use_data() • usethis::use_data() создаёт каталог data, если его ещё нет • Добавляет в каталог data .rda файлы • Добавляет блок LazyData: true в DESCRIPTION файл
- 5. Внутренние данные • Внутренние системные данные вашего пакета хранятся в R/sysdata.rda файле. • В отличие от экспортируемых данных, все внутренние данные сохраняются в один файл • Внутренние данные создаются с помощью команды usethis::use_data(internal = TRUE) • Данная команда создаёт файл R/sysdata.rda • При этом внутренние данные не экспортируются при подключении пакета • При этом не вносятся никакие изменения в файл DESCRIPTION
- 6. Необработанные данные • Необработанные данные хранятся в папке inst/extdata/ • Получить путь к сохранённым необработанным данным можно командой system.file("extdata", package = “package_name")
- 9. Внутреннее состояние пакета • При необходимости иметь возможность динамически изменять некоторые внутренние данные пакета в ходе R сеанса создайте внутри него отдельную, пустую среду.
- 10. Постоянные пользовательские данные • Если вам необходимо хранить системные данные, которые должны быть доступны между разными R сеансами, то их необходимо хранить на жестком диске. • При этом обязательно необходимо соблюдать спецификацию каталогов принятой для вашей операционной системы, для определения директорий в которых вы будете хранить файлы вашего пакета используйте функцию tools::R_user_dir(): • tools::R_user_dir("pkg", which = "data") – хранение данных • tools::R_user_dir("pkg", which = "config") – хранение конфигов • tools::R_user_dir("pkg", which = "cache") – хранение кешированных данных • Альтарнативный способ предоставляет пакет rappdirs
- 11. Прочие каталоги пакета • src/ - каталог для хранения скомпилированного кода, зачастую для функций, написанных на С или С++. • inst/ - для произвольных дополнительных файлов, файлы цитирования пакета, надстройки для RStudio, rmarkdown шаблоны. • tools/ - вспомогательные файлы, необходимые при настройке, обычно находятся в комплекте со скриптом configure. • exec/ - для исполняемых скриптов. В отличие от файлов, размещенных в других каталогах, файлы внутри exec/автоматически помечаются как исполняемые. На сегодняшний день более предпочтительным является каталог inst/.