Есть ли способ автоматического обновления документации в пакете R?
Я использовал package.skeleton() для создания файлов справки.Rd несколько месяцев назад. Я отредактировал эти файлы, а также изменил функции, удалил некоторые функции, добавил другие. Есть ли функция, которая автоматизирует обновление файлов Rd?
Обновить
Недавно был выпущен хороший пакет под названием Rd2roxygen, он описан автором Yihui Xie в его блоге.
Как следует из названия, этот пакет позволяет задним числом вставлять документацию, которая в настоящее время содержится в.Rd, в файлы.R. Звучит как многообещающий подход как для изучения roxygen, так и для преобразования пакетов, находящихся в разработке, в пакеты R. Уу ууу. Спасибо Йихуэй!
Судя по ответам Джошуа и Иихуэя, ответ выглядит следующим образом: roxygen позволяет автоматически обновлять Rd-файлы и т. Д. На основании изменений в исходном.R-коде, и если я сейчас не использую roxygen, Rd2roxygen может помочь мне в миграции.
3 ответа
Rd2roxygen был разработан, чтобы помочь разработчикам пакетов, которые "застряли" в необработанных Rd-файлах, но хотят переключиться на roxygen - он может обрабатывать Rd-файлы и обновлять R-скрипты с комментариями roxygen. С этого момента вы можете начать пользоваться силой roxygen, Так Rd2roxygen это не прямой ответ, но он может помочь вам с переходом.
Это не дает конкретного ответа на ваш вопрос, но вас может заинтересовать Roxygen.
Нет, я так не думаю.
Но вы можете попробовать снова package.skeleton() для новых или измененных функций, а затем объединить это вручную.