Возможно ли/целесообразно пропустить roxygen в пользу roxygen2?

Недавно я указал на Roxygen, чтобы решить мои проблемы с документацией/лень. Но тогда есть этот блестящий Roxygen2, который, по моему мнению, является своего рода собственностью. Инструменты пакета Hadley требуют использования Roxygen2, но, похоже, нечего делать путем сквозного перехода.

Учитывая, что я начинаю с нуля в процессе обучения:

  • Есть ли прецедент для нового пользователя, который предпочитает Roxygen вместо Roxygen2, или Roxygen2 лучше всех?

  • Если да, то какие ресурсы существуют для его изучения (желательно те, которые не полагаются на прежнее знание Roxygen)?

  • Является ли Roxygen2 обратной совместимостью с Roxygen (так что время, потраченное на обучение и запись Roxygen, будет перенесено)?

ОТВЕТЫ

Ответ 1

Я переключил свои скрипты сборки на вызов roxygen2 вместо roxygen, и все работало по-прежнему, за исключением того, что теперь я получаю хороший, автоматически сгенерированный файл NAMESPACE.

Итак, изучение roxygen означает, что вы изучаете основы roxygen2. Я уверен, что я не использую все новые функции, но для основ roxygen2 работает так же, как roxygen.

Я также добавил бы, что install_github() в пакете devtools (также на github) абсолютно велика. Для пакетов, которые не достойны CRAN, github - отличный способ пойти.

Ответ 2

Нет причин предпочитать roxygen для roxygen2, если начать с нуля. Мы работаем над вводной статьей для новостей r.