Избегайте повторения описания пакета в файле ОПИСАНИЯ и документации по пакету roxygen

#r #r-package

Вопрос:

При создании пакета R следуйте советам https://r-pkgs.org/index.html, вам, по-видимому, нужно поместить описание вашего пакета в два отдельных места. Один раз в Description поле DESCRIPTION файла (описано здесь) и второй раз в документации по пакету, которая будет проанализирована roxygen2 (описано здесь). Что касается документации по пакету, я знаю, что это полезно для других вещей, таких как @import заявления, но вам все равно нужен @description раздел, и devtools::check() я буду жаловаться, если вы этого не сделаете.

Однако мне кажется, что это та же информация: краткое, но состоящее из нескольких предложений описание вашей посылки. Правильно ли я понимаю? Если да, то есть ли способ написать описание только один раз и скопировать его во время процесса сборки пакета? Если нет, то каковы различия в тексте, который следует поместить в каждом месте?