2015-12-01 3 views
2

Название было длинным, и действительно сказал все, что я должен был сказать. Но когда вы делаете R-пакет и помещаете его в github, необходимо ли создавать документацию с помощью roxygen до нажатия на github? В противном случае у меня возникают проблемы при использовании devtools::install_github, потому что NAMESPACE не строится правильно (если hocs уже был построен). Я спрашиваю, потому что было бы неплохо не хранить все файлы .Rd в каждом репозитории, а вместо этого строить их во время установки. Я что-то упустил? Плюс, каждый раз, когда они перестраиваются, папка .git становится все больше и больше.Используя install_github, необходимо ли правильно создать документацию для NAMESPACE?

Это немного смутило меня, потому что у меня были функции, которые я экспортировал (@export), но не строил документацию и не понимал, что это необходимо.

+0

'devtools ::: source_pkg' получил параметр' before_install', который принимает функцию. Вероятно, вы могли бы передать ему «roxygenize» через эллипсы. Не могу проверить, так как вы не предоставили тестовый пример. – Roland

+0

На второй взгляд вы не можете. К сожалению, эллипсы ему не передают. – Roland

ответ

5

является необходимым для создания документации roxygen до нажатия на GitHub

Да. Документация, файл NAMESPACE, все они являются частью полного, устанавливаемого пакета.

было бы неплохо, чтобы не хранить все файлы .Rd в каждом хранилище, но вместо того, чтобы построить их во время установки

Это было бы предположить, что каждый использует roxygen2 строить .Rd файлы, но roxygen является относительно недавней разработкой и не требуется. Раньше было принято писать файлы .Rd вручную (:: shudder ::).

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

.Rd файлы крошечные, просто поместите их в свое репо.