Я новичок в создании собственных пакетов и использую roxygen2.
Я создаю пакет с множеством внутренних вспомогательных функций, и мне было интересно, нужно ли мне документировать их все. Я понимаю важность документации, но некоторые функции довольно просты и для удобства просто обертывают другие функции. Я провел базовый поиск в Интернете, но, похоже, не смог найти окончательного ответа.
Любая помощь приветствуется.
Это зависит от того, что вы подразумеваете под «должен». Одна из интерпретаций: «Должен ли я документировать эти функции, чтобы пройти проверку?» Ответ на этот вопрос - нет. Пока функция не экспортируется из пакета, R CMD check не требует ее документирования.
Другая интерпретация: «Должен ли я документировать это, чтобы помочь себе в обслуживании этого пакета?» На этот вопрос сложнее ответить. Некоторые функции настолько очевидны, что им не нужна никакая документация, кроме их имени, например. метод print без дополнительных аргументов, кроме общих.
Другие функции не так очевидны или имеют аргументы, значение которых неочевидно. Это хорошая идея задокументировать их, если вы планируете поддерживать свой пакет в течение длительного времени, потому что вы можете забыть детали с этого момента и всякий раз, когда возникает проблема. И если вы выпускаете свой пакет для других, вы должны планировать долгосрочное обслуживание, потому что, если он будет полезен, люди будут его использовать.
