2015-01-14 1 views
0

Мне нужно создать документацию для коллекции программ R. К сожалению, создание пакета на основе исходного кода не является вариантом (я знаю, как это сделать, и я уже экспериментировал с RStudio, roxygen2 и пакетами, и это работает как шарм). Могу ли я использовать roxygen2 для создания документации из исходного кода R без создания пакета таким же образом, как doxygen работает с C++? Если нет, существуют ли другие варианты документирования R-кода, который не полагается на пакеты?Могу ли я генерировать комментарии с помощью roxygen2 без создания пакета R?

+0

Я смущен, если вы не используете пакет (а почему бы и нет?), Что вы будете делать с файлами Rd? – baptiste

+0

@baptiste 'R CMD Rd2pdf' сделает хороший PDF-файл из вашего Rd-файла ... – Spacedman

+0

Файлы Rd могут быть преобразованы в HTML и сохранены в каталог, возможно, с индексом или оглавлением. Doxygen для C++ работает на уровне файла и не требует дополнительной структуры (например, в этом случае R-пакет). Я надеялся, что что-то подобное может существовать в R. Причина, по которой я не могу создать пакет, заключается в том, что существует уже существующий код, структура каталогов которого я не должен изменять. – akinw

ответ

0

Если только после документации, devtools::document() будет создавать файлы документации без создания пакета.

+0

, вызывающий 'roxygen2 :: roxygenise' внутри, и предполагает стандартную структуру каталогов пакетов – baptiste

Смежные вопросы