Описание тега roxygen

Roxygen- это система документации в исходном коде для R.Она основана на Doxygen и является альтернативой созданию файлов.Rd, поскольку автоматически создает файлы.Rd пакета из документации в исходном коде.

Первое предложение любого блока Roxygen кратко описывает его объект; и может сопровождаться тегом Roxygen или более подробным описанием.

Подробное описание начинается после пустой строки и продолжается до первого тега Roxygen.

Каждый тег Roxygen начинается с амперсанда, например @name, @author и т. Д.; что, кстати, означает, что все действительные амперсанды должны быть экранированы двойным амперсандом.

Доступность

До 2018 года Roxigen размещался на http://roxygen.org/. Смотрите его на Wayback Machine по адресу https://web.archive.org/web/20180809105527/http://roxygen.org/.