Встроенная обзорная документация по пакетам с использованием roxygen

Я предполагаю, что это простая вещь, которую я постоянно упускаю из виду в документации, но я не могу понять, как заставить документацию на уровне пакета работать в R. Я не имею в виду документацию по функциям или классам, но документация, которую вы получаете при вводе, например, ?stats.

Я следовал общим инструкциям, которые нашел в Интернете, и создал файл документации скелета, сохраненный как .R. Файл .R копируется вместе со сценариями пакета, но справочная документация не превращается в файл .Rd (если только я не добавлю определение функции, также названное в честь пакета).

Пример того, что я пробовал:

#'_PACKAGE
#'MyPackage
#'
#'MyPackage description
#'
#'MyPackage details
#'@alias{MyPackage}
#'@alias{MyPackage-package}

По какой-то причине мне трудно найти хорошие примеры того, как настроить общую документацию по пакетам. Я написал довольно много файлов справки по функциям, и я знаю, что roxygen находит мой файл справки по пакету, но непонятно, почему я не могу сгенерировать из него .Rd.


person Joel Graff    schedule 23.12.2015    source источник
comment
Вам нужен NULL в строке, следующей за вашей документацией. см. здесь пример.   -  person Josh O'Brien    schedule 23.12.2015
comment
Вы можете изменить название вашего вопроса. Это не «общая документация по пакету». Вы знаете, как это сделать в Rd-файле — речь идет об определенном аспекте roxygen2.   -  person Dirk Eddelbuettel    schedule 23.12.2015
comment
@slickrickulicious Согласен. Попробуйте также identical(NULL, {}), чтобы понять, почему оба варианта работают одинаково хорошо.   -  person Josh O'Brien    schedule 23.12.2015
comment
Также обновлено название. Я пытался избежать комментариев о том, как документировать функции, а не пакет в целом.   -  person Joel Graff    schedule 23.12.2015
comment
Редактирование исходного комментария: добавлены фигурные скобки вокруг '\ name', когда я не должен был этого делать. После удаления заработало!   -  person Joel Graff    schedule 23.12.2015


Ответы (1)


Ответ любезно предоставлен @slickrickulicious в комментариях выше:

Мне нужно было добавить NULL в конец моего файла документации и включить «@name MyPackage». При этом файл справки по пакету был сгенерирован правильно.

person Joel Graff    schedule 23.12.2015