Автоматическое обновление документации R, файлов NAMESPACE и DESCRIPTION при отправке кода на github

Question

Мне нужно знать, могу ли я автоматически запускать команды devtools::document() и roxygen2::roxygenise() в RStudio или в Teamcity всякий раз, когда в github делается pu sh вместо того, чтобы запускать эти команды вручную перед каждым нажатием. Как это может быть сделано ?

Answer 1

Я мог бы сделать скрипт .git/hooks/pre-commit, который запускается: R -e 'devtools::document()'. Поиск в сети для хуков предварительной фиксации. Как только ваш хук настроен, коммит через любой интерфейс (Rstudio или что-то еще) будет автоматически использовать его. Вы можете настроить скрипт так, чтобы он возвращал ошибку, если какая-либо ошибка возникает в devtools::document(), предотвращая коммит кода.

Обратите внимание, что обычно достаточно запустить devtools :: document (), второй roxygen2 :: roxygenise Команда () обычно не нужна!

Наконец, я настоятельно советую этого не делать: в вашем рабочем процессе кодирования разумно документировать пакет перед его фиксацией: это может напомнить вам о том, что вы забыли сделать.