R создать справочное руководство с проверкой R CMD

Я пишу пакет R и хотел бы сделать справочное руководство по PDF для всех функций в пакете. Из здесь я понял, что R CMD check автоматически создает справочное руководство.

Здесь я прочитал, что создается ручная запись "функций, которые вы перечислили в разделе экспорта NAMESPACE".

Мой файл NAMESPACE выглядит следующим образом:

# Export all names
exportPattern(".")

# Import all packages listed as Imports or Depends
import(
  LIM
)

поэтому я думал, что все будет экспортировано. Во время R CMD check в каталоге пакетов в самом конце написано:

 * checking PDF version of manual ... OK

Однако я не нахожу справочное руководство в своем каталоге пакетов (я бы предположил, что оно будет в inst/doc). Что мне здесь не хватает?

Ответ 1

R CMD check создает каталог PACKAGE.RCheck. В этом каталоге вы можете найти файл PACKAGE-manual.pdf.

Ответ 2

Другой способ - создать справочное руководство напрямую, используя:

R CMD Rd2pdf mypackage

где mypackage - это папка, содержащая вашу структуру папок кода пакета R, включая папку man с вашими файлами .Rd.

По какой-то причине я никогда не получаю справочное руководство во время сборки или проверки в RStudio, может быть, потому, что я где-то пропустил настройку. Но выполнение этой команды отлично работает.

Ответ 3

Я была такая же проблема. Кажется, что когда вы нажимаете Build или Check in Rstudio (при использовании devtools), по умолчанию аргументы '--no-manual' добавляются в опции R CMD.

Я решил эту проблему, вручную указав аргументы в командной строке R:

library(devtools)

check(cleanup = FALSE,manual = TRUE,path = getwd())

# without running the examples
check(cleanup = FALSE,args = c('--no-examples'),manual = TRUE,path = getwd())

В этом случае папка с именем package.Rcheck будет содержать руководство как package-manual.pdf

Также проверьте на наличие ошибок в выводе во время проверки. Там могут быть символы, которые могут привести к сбою документации.

Ответ 4

Другим обходным решением является его ширина:

build_manual(path=getwd())
#or
check(manual = TRUE, args="--output=~/folder/subfolder")