Автоматическое обновление документации данных, когда эти данные обновляются - PullRequest
0 голосов
/ 02 сентября 2018

Я создаю пакет и включаю данные экспериментов. Эксперименты продолжаются, и поэтому в будущем данные изменятся.

Я использую roxygen2 для документации и хотел бы добавить описание, подобное следующему:

#' Data_foo contains the experimental data of [x] participants

В будущем «х» изменится. Конечно, я всегда могу обновить это вручную - не очень большая проблема - или я мог бы просто решить , а не , чтобы документировать вот так.

Но я просто удивился, возможно ли это вообще, и если - как (например, может ли существовать аналогичный уценке встроенный код?)

1 Ответ

0 голосов
/ 03 сентября 2018

Да, формат Rd (который производит Roxygen) поддерживает это. Используйте синтаксис, такой как \Sexpr{nrow(foo_package::Data_foo)}, где вы хотите, чтобы [x] появился.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...