Система автоматической документации для R глянцевая - PullRequest
0 голосов
/ 19 ноября 2018

Я прошу любой совет, как сделать документирование / автоматическое документирование для больших блестящих приложений.

R-пакеты имеют roxygen2, но есть ли эквиваленты автоматической документации для кода сервера и пользовательского интерфейса?

Я работаю над развивающимся проектом с +15 тыс. Строк кода, и мы максимально загружаем пакеты с документами roxygen2, однако все это наблюдает и реагирует в скрипте центрального сервера, и его подписки не документируются автоматически. Я также, конечно, использую git.

Я попытался пометить все наблюдения, реактивы, модули и т. Д. В исходном коде уникальным идентификатором и нарисовать диаграмму вручную с соответствующими идентификаторами. Диаграмма описывает, какой тип подэлемента и темы. Позже я бы добавил все триггеры и т. Д. Хотя этот процесс очень ручной. Может быть, я мог бы использовать «реактивный журнал» https://shiny.rstudio.com/articles/debugging.html для автоматического создания такой документации?

enter image description here

... обновление 1 : я пробовал ShinyTester, который читает исходный код и пытается предсказать сеть взаимодействий подэлементов. Он не обрабатывал источники внешних файлов, но с небольшой отладкой мне удалось получить диаграмму ниже. К сожалению, только 5% элементов и взаимодействий были обнаружены при этом. Может быть, ShinyTester может понадобиться какой-то вклад. : enter image description here

...