Есть ли способ автоматически обновлять документацию в пакете R?

StackOverflow https://stackoverflow.com/questions/4099963

  •  29-09-2019
  •  | 
  •  

Вопрос

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

Обновить

Хороший пакет был только что выпущен Rd2roxygen, это описывается автором Йихуи Си на его блог.

В качестве имени подразумевается, этот пакет позволяет ретроактивно вставить документацию, содержащуюся в настоящее время в .rd в файлах .r. Похоже, как многообещающий подход для обучения ROXYGON, так и для преобразования пакетов, в настоящее время в разработке до пакетов R. Woo Hoo. Спасибо Yihui!

На основании ответов Джошуа и Yihui, ответ кажется: Roxygen позволяет автоматическое обновление RD -файлов и т. Д. На основе изменений в коде Source .R, и если я не использую Roxygen в настоящее время, RD2roxygen может помочь мне мигрировать.

Это было полезно?

Решение

Rd2roxygen был разработан, чтобы помочь разработчикам пакетов, которые «застряли» в RAW RD -файлах, но хотят переключиться на roxygen - Он может обрабатывать RD-файлы и обновлять r скрипты с комментариями ROXYGON. С тех пор вы можете начать наслаждаться силой roxygen. Анкет Так Rd2roxygen это не прямой ответ, но это может помочь вам с переходом.

Другие советы

Это конкретно не отвечает на ваш вопрос, но вам может быть интересно Роксиген.

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

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

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top