Есть ли способ автоматического обновления документации в пакете R? - PullRequest
7 голосов
/ 04 ноября 2010

Несколько месяцев назад я использовал package.skeleton () для создания файлов справки .Rd.Я отредактировал эти файлы, а также изменил функции, удалил некоторые функции, добавил другие.Есть ли функция, которая автоматизирует обновление файлов Rd?

update

Только что был выпущен хороший пакет с именем Rd2roxygen , он описываетсяавтор Yihui Xie в своем блоге .

Как видно из названия, этот пакет позволяет задним числом вставлять документацию, которая в настоящее время содержится в .Rd, в файлы .R.Звучит как многообещающий подход как для изучения roxygen, так и для преобразования пакетов, находящихся в разработке, в пакеты R.Уу ууу.Спасибо Yihui!

Исходя из ответов Джошуа и Ии Хуи, ответ выглядит так: roxygen позволяет автоматически обновлять Rd-файлы и т. Д. На основе изменений в исходном .R-коде, и еслиВ настоящее время я не использую roxygen, Rd2roxygen может помочь мне мигрировать.

Ответы [ 3 ]

10 голосов
/ 01 января 2011

Rd2roxygen был разработан, чтобы помочь разработчикам пакетов, которые «застряли» в необработанных Rd-файлах, но хотят переключиться на roxygen - он может обрабатывать Rd-файлы и обновлять R-сценарии с помощью комментариев roxygen. С этого момента вы можете начать пользоваться силой roxygen. Так что Rd2roxygen не является прямым ответом, но может помочь вам с переходом.

9 голосов
/ 04 ноября 2010

Это конкретно не отвечает на ваш вопрос, но вас может заинтересовать Roxygen .

1 голос
/ 04 ноября 2010

Нет, я так не думаю.

Но вы можете попробовать запустить package.skeleton() для новых или измененных функций, а затем объединить это вручную.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...