wickham - ¿Dónde colocar las viñetas del paquete para la presentación de CRAN?

use packages in r

Question

En el Manual de Extensiones de R de R , leí eso.

A partir de la versión 2.14.0 de R, la ubicación preferida para las fuentes de Sweave son las viñetas del subdirectorio de los paquetes de fuente, pero para la compatibilidad con versiones anteriores de R, las fuentes de viñeta se buscarán en inst / doc si no existen viñetas.

Sin embargo, cuando creo un subdirectorio de vignettes del origen del paquete, cuando ejecuto devtools::check() o R CMD check recibo una advertencia para la Package vignette(s) without corresponding PDF . Si pongo la viñeta (.Rnw y .pdf) en inst/doc la comprobación se completa sin quejas. Intenté buscar en mi biblioteca el paquete instalado y no vi ningún directorio llamado vignettes . ¿Debo seguir utilizando la ubicación en desuso?

Answer 1

Me costó mucho interpretar esto también.

Creo que la intención es que coloques el archivo .Rnw en vignettes/ y el PDF (adecuadamente compactado) en inst/doc/ , que técnicamente está de acuerdo con la documentación si lees con la suficiente atención. (Es decir, dice que las fuentes deben ir en vignettes/ . No veo lo que dice en tantas palabras que debería colocar el PDF correspondiente en inst/doc/ , pero no lo dice, y Esa interpretación parece hacer feliz a R CMD check ...)

La resolución está en la respuesta de @GavinSimpson (es decir, se espera que uno construya el archivo comprimido y luego lo revise, en lugar de verificar el propio directorio de origen). (Mis dos centavos es que podría ser mejor si R-core oficialmente desaprobara (y finalmente se eliminara) la verificación directa de la fuente en lugar de confundirnos a todos los molestos ...)

Answer 2

Puso las fuentes .Rnw en vignettes/ como lo hizo, pero perdió un paso crítico; no compruebe el árbol de origen. El flujo de trabajo esperado es construir el código fuente y luego verificarlo. Construyendo el tarball se creará la viñeta PDF.

R CMD build ../foo/pkg
R CMD check ./pkg-0.4.tar.gz

por ejemplo, creará un paquete de código fuente a partir de las fuentes en ../foo/pkg creando el paquete .tar.gz en el directorio actual con el nombre del paquete y la versión adjunta. Luego ejecuta R CMD check en ese paquete fuente.

Si quiere que su viñeta sea construida para usted, póngala en vignettes/ y compile el paquete fuente. En alguna fecha futura, R Core puede eliminar la capacidad de crear viñetas desde inst/doc así que vaya a la ubicación recomendada ahora y evite verificar las fuentes directamente.