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

Я пишу пакет 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). Что мне здесь не хватает?

Источник

3 ответа

Решение

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

Источник

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

R CMD Rd2pdf mypackage

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

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

Источник

Я была такая же проблема. Кажется, что когда вы нажимаете 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

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

Источник

Другой обходной путь должен произвести это ширина:

build_manual(path=getwd())
#or
check(manual = TRUE, args="--output=~/folder/subfolder")
Источник
Другие вопросы по тегам