Презентация к 5 уроку курса разработка пакета на языке R

1. DESCRIPTION
Метеданные пакета
Разбираемся с основными полями
Алексей Селезнёв

2. Мой telegram канал

3. Задача файла DESCRIPTION—
хранить важные метаданные о
вашем пакете.

4. Минимальный пример файла DESCRIPTION

5. Опции пакета usethis

6. Title и Descripton
• Title представляет собой однострочное описание пакета и часто отображается в листинге
пакета. Это должен быть обычный текст (без разметки), каждое слово должно начинаться с
заглавной буквы, и НЕ заканчивающийся точкой. Будьте краткими: списки часто урезают
заголовок до 65 символов.
• Description более подробное описание, чем заголовок. Вы можете использовать несколько
предложений, но вы ограничены одним абзацем. Если ваше описание занимает несколько
строк (а так и должно быть!), ширина каждой строки не должна превышать 80 символов.
Отступ последующих строк с 4 пробелами.

7. Authors@R
• Функция person() имеет четыре основных аргумента:
• Имя, указанное первыми двумя аргументами given и family (обычно они задаются по положению, а не
по имени).
• email, который является абсолютным требованием для сопровождающего. Важно отметить, что это
адрес, который CRAN использует, чтобы сообщить вам, нужно ли исправить ваш пакет, чтобы остаться
в CRAN.
• Один или несколько трехбуквенных кодов, определяющих расширение role. Вот самые важные роли, о
которых нужно знать:
• cre: создатель или сопровождающий, человек, которого вы должны беспокоить, если у вас есть проблемы.
• aut: авторы, внесшие значительный вклад в разработку пакета.
• ctb: участники, те, кто внес меньший вклад, например патчи.
• cph: правообладатель. Это используется для перечисления дополнительных правообладателей, которые не
являются авторами, как правило, компаний, таких как работодатель одного или нескольких авторов.
• fnd : спонсор, люди или организации, предоставившие финансовую поддержку для разработки пакета.

8. URL и BugReports
• Поле URL обычно используется для рекламы веб-сайта пакета и для ссылки на
общедоступный репозиторий исходных кодов, где происходит разработка.
• BugReports это URL-адрес, по которому следует отправлять отчеты об ошибках, например,
как раздел issues GitHub.

9. License
• Поле License является обязательным и должно указывать лицензию вашего пакета в
стандартной форме, распознаваемой R. Важно понимать, что это, по сути, машиночитаемое
License поле.
• Наиболее удобный способ установки лицензии в файле DESCRIPTION предоставляют
следующие функции:
• use_mit_license() – если вам нужна лицензия, чтобы люди могли использовать ваш код с
минимальными ограничениями
• use_gpl_license() - если вам нужна лицензия с авторским левом, чтобы все производные и пакеты
вашего кода также имели открытый исходный код
• use_cc0_license() - если ваш пакет в основном содержит данные, а не код, и вам нужны минимальные
ограничения
• use_ccby_license() – если ваш пакет содержит только данные, но вы хотите указания вашего авторства
• use_proprietary_license() - если вы не хотите делать свой код открытым (На CRAN не пустят)

10. Imports, Suggests, …
• Пакеты, перечисленные в, Imports необходимы вашим пользователям во время выполнения
и будут установлены (или потенциально обновлены), когда пользователи установят ваш
пакет через install.packages().
• Пакеты, перечисленные в, Suggests либо необходимы для задач разработки, либо могут
разблокировать дополнительные возможности пакета для ваших пользователей.

11. Другие поля
• Version – Версия вашего пакета, удобный способ сообщить на какой версии разработки находится
ваш пакет.
• LazyData – актуален если ваш пакет делает данные доступными для пользователя. Если вы
укажете LazyData: true, наборы данных загружаются отложенно, что делает их более доступными,
т. е. пользователям не нужно использовать data().
• Encoding – Описывает кодировку файлов вашего пакета.
• Collate - управляет порядком получения файлов R.
• VignetteBuilder - перечисляет любой пакет, который нужен вашему пакету в качестве механизма
виньетирования.
• SystemRequirements - Здесь вы описываете зависимости, внешние по отношению к R. Это обычное
текстовое поле, которое, например, фактически не устанавливает и не проверяет что-либо,
поэтому вам может потребоваться включить дополнительные сведения об установке в файл
README.

12. Пользовательские поля
• Существует также некоторая гибкость для создания собственных полей для добавления
дополнительных метаданных. В самом узком смысле единственным ограничением
является то, что вы не должны переназначать официальные имена полей, используемые R.
Вы также должны ограничить себя допустимыми английскими словами, чтобы имена полей
не помечались проверкой орфографии.
• На практике, если вы планируете отправлять в CRAN, мы рекомендуем, чтобы имя любого
настраиваемого поля начиналось с Config/.

13. СПАСИБО ЗА ВНИМАНИЕ