Где включить текстовые заметки в структуру каталогов пакета R?

Question

Я создал пакет R, который в настоящее время имеет следующую структуру каталогов:

.git 
.Rproj.user 
docs 
inst 
man 
Meta 
R 
tests 
vignettes

Я храню код пакета в репозитории GitHub. Я хочу добавить примечание в виде файла TXT, который будет содержать некоторую информацию, относящуюся к пакету (псевдокод основного алгоритма пакета). Я хочу добавить его в пакет, чтобы к нему можно было получить доступ из репозитория пакета GitHub.

Какое место в файлах лучше всего добавить, чтобы при проверке пакета не появлялось сообщение о том, что какой-то избыточный файл завис?

Answer 1

Секция подкаталогов пакета из Запись расширений R - это каноническая ссылка (хотя и довольно плотная и техническая).

Вы можете поместить ее в inst/doc, например: я не думаю, что что-то в inst/ специально проверено.

В качестве альтернативы, если вы хотите, чтобы это было на GitHub, но не было включено в материал пакета, поместите файл имя в .Rbuildignore (ваши .git, .Rproj.user, et c. уже должны быть там; я не уверен, почему у вас есть каталог Meta, который обычно находится в установленных пакетах ?). (Я бы посоветовал вам ввести его в inst/doc, чтобы конечные пользователи, установившие пакет, могли найти его, если захотят.)