В чем разница между README и виньеткой в ​​пакете R? - PullRequest
Новая
       36

В чем разница между README и виньеткой в ​​пакете R?

0 голосов
/ 17 декабря 2018

У меня есть пакет R на GitHub, который я собираюсь отправить в CRAN.До сих пор в пакете содержался обширный документ README.md, который показывает:

  • примеры выполнения основных функций пакета,
  • примеры демонстрационного выполнения пакета,
  • некоторые результаты тестов.

Для пользователей GitHub я подумал, что поместить их в README.md более привлекательно, чем виньетка, так как он появляется, когда пользователь просматривает репозиторий пакета.

Когда я нахожусь на этапе перемещения пакета в CRAN , я бы хотел иметь почти такой же контент, как в настоящее время в README.md, доступный в виде виньетки.

Вопрос: правильный ли это способ сделать почти 1-1 копию README.md в виньетке, сохранить оба, обновить репозиторий GitHub, чтобы также иметь эту виньетку, а затем отправить как таковуюКРАН?Или: это приведет к дублированию, которое не должно иметь место?(тогда как мне действовать?)

1 Ответ

0 голосов
/ 17 декабря 2018

Да, я думаю, что это не редкость.У вас

  • есть файл README.md на GitHub в качестве «публичного лица» (исходного) пакета репозитория
  • , если вам нужна сводка пакета, для которой виньетка может хорошо подойти
  • может даже закончиться веб-пакетом или сводкой

, а такой же текст уценки может также использоваться во всех трех случаях.

В любомВ этом случае нет никаких правил против этого.Кроме того, если бы вы не знали, это был бы хороший вопрос для выделенного и целенаправленного списка рассылки r-package-devel, касающегося упаковки.

...