para - poligono en r

R crea manual de referencia con R CMD check

Question

Estoy escribiendo un paquete R y me gustaría hacer un manual de referencia en pdf de todas las funciones del paquete. Entendí a partir de here que R CMD check crea automáticamente un manual de referencia.

Here leí que se crea una entrada manual "de las funciones que enumeró en la sección de exportación de NAMESPACE".

Mi archivo NAMESPACE se ve como sigue:

# Export all names
exportPattern(".")

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

Así que pensé que todo será exportado. Durante la R CMD check en el directorio del paquete, al final dice:

 * checking PDF version of manual ... OK

Sin embargo, no encuentro un manual de referencia en mi directorio de paquetes (supongo que estaría en inst / doc). ¿Que me estoy perdiendo aqui?

Answer 1

Otra forma es crear el manual de referencia directamente usando:

R CMD Rd2pdf mypackage

donde mypackage es la carpeta que contiene la estructura de carpetas del código del paquete R, incluida la carpeta man con sus archivos .Rd.

Por alguna razón, nunca obtengo el manual de referencia durante la compilación o el registro en RStudio, tal vez porque me he perdido una configuración en algún lugar. Pero ejecutar el comando así también funciona bien.

Answer 2

Tuve el mismo problema. Parece que al hacer clic en Generar o Registrar en Rstudio (cuando se usa devtools), de forma predeterminada, los argumentos de ''--no-manual'' se agregan a las opciones de R CMD.

Resolví esto dando manualmente los argumentos en el símbolo del sistema de 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())

En este caso, una carpeta llamada package.Rcheck contendrá el manual como package-manual.pdf

También compruebe si hay errores en la salida durante la comprobación. Puede haber caracteres que puedan bloquear la documentación.

HTH

Answer 3

R CMD check crea un directorio PACKAGE.RCheck . En este directorio puede encontrar el archivo PACKAGE-manual.pdf .