Я предполагаю, что это простая вещь, которую я продолжаю игнорировать в документации, но я не могу понять, как получить документацию на уровне пакета для работы в R. Я не имею в виду к документации по функциям или классу, но к документации, которую вы получаете при вводе, например, «stats».Документация по пакетной документации Inline с использованием roxygen
Я выполнил общие инструкции, которые я нашел в Интернете, создав файл документации sckeleton, сохраненный как .R. Файл .R копируется с помощью сценариев пакета, но справочная документация не попадает в файл .Rd (если я не добавлю определение функции, также названное после пакета).
Пример того, что я пробовал:
#'_PACKAGE
#'MyPackage
#'
#'MyPackage description
#'
#'MyPackage details
#'@alias{MyPackage}
#'@alias{MyPackage-package}
Я с трудом найти хорошие примеры того, как создать общую документацию пакета, по какой-то причине. Я написал немало файлов справки по функциям, и я знаю, что файл справки по моему файлу найден roxygen, но неясно, почему я не могу сгенерировать с него .Rd.
Вам нужна «NULL» на линии, следующей за вашей документацией. [См. Здесь] (http://r-pkgs.had.co.nz/man.html#man-packages) для примера. –
Возможно, вы захотите изменить название своего вопроса. Это не «общая документация пакета». Вы знаете, как это сделать в Rd-файле - это касается конкретного аспекта roxygen2. –
@slickrickulicious Согласовано. Попробуйте также «идентичные (NULL, {})», чтобы понять, почему обе работают одинаково хорошо. –