Фон
Я написал пакет R, и теперь коллаборационист (недавний CS grad, который является новым для R), редактирует и реорганизует код. В этом процессе он делит мои функции на более мелкие, более общие функции.
То, что он делает, имеет смысл, но когда я начал с package.skeleton()
, у меня был один файл для каждой функции. Теперь он добавил функции, от которых зависит основная функция, но которая может иметь ограниченное использование вне самой функции.
Он предлагает, чтобы все функции вошли в один файл, но я против этого, потому что легче работать с контролем версий, когда мы работаем с разными файлами.
С тех пор я начал использовать roxygen для документирования каждой функции в тексте.
Вопрос
Каков рекомендуемый способ обработки функций: ясно, что вспомогательные функции должны оставаться с основной функцией, но в какой мере мне нужно документировать вспомогательные функции?
Рекомендация @export
в комментариях полезна, но мне любопытно узнать, как другие организуют свой код.