Question Où placer des vignettes de paquets pour la soumission CRAN?


Du Ecriture du manuel des extensions R, Je lis ça

A partir de R 2.14.0, l’emplacement préféré des sources Sweave est le   vignettes de sous-répertoires des paquets source, mais pour compatibilité   avec les versions antérieures de R, les sources de vignettes seront recherchées dans   inst / doc si les vignettes n'existent pas.

Cependant, quand je crée un vignettes sous-répertoire de la source du paquet, quand je cours devtools::check() ou R CMD check Je reçois un avertissement pour Package vignette(s) without corresponding PDF. Si je mets la vignette (.Rnw et .pdf) dans inst/doc le chèque se termine sans plaintes. J'ai essayé de regarder dans ma bibliothèque au paquet installé et je n'ai vu aucun répertoire nommé vignettes. Dois-je toujours utiliser le lieu obsolète?


20
2017-09-07 20:51


origine


Réponses:


Vous mettez le .Rnw sources dans vignettes/ comme vous l'avez fait, mais vous avez manqué une étape critique; ne pas vérifier l'arborescence source. Le workflow attendu consiste à créer l'archive tar source, puis à vérifier cette archive. La construction de l'archive créera la vignette PDF.

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

par exemple, compiler une archive de paquet source à partir des sources dans ../foo/pkg créer le .tar.gz package dans le répertoire en cours avec le nom du package et la version ajoutée. Puis tu cours R CMD check sur ce paquet source.

Si vous voulez que votre vignette soit construite pour vous, mettez-la dans vignettes/ et construisez le paquet source. À une date ultérieure, R Core peut supprimer la possibilité de créer des vignettes à partir de inst/doc alors allez avec l'emplacement conseillé maintenant et évitez de vérifier les sources directement.


20
2017-09-07 21:04



J'ai eu du mal à interpréter cela aussi.

Je crois que l'intention est que vous devriez mettre le .Rnw déposer dans vignettes/ et le PDF (convenablement compacté) en inst/doc/, qui est techniquement en accord avec la documentation si vous lisez suffisamment attentivement. (C'est à dire, le sources devrait aller dans vignettes/. Je ne vois pas où il est dit dans tant de mots que vous devriez mettre le PDF correspondant dans inst/doc/, mais ça ne ne pas dites-le, et cette interprétation semble faire R CMD check content ...)

La résolution est dans la réponse de @ GavinSimpson (c’est-à-dire que l’on est censé créer l’archive tar, puis la vérifier, plutôt que de vérifier le répertoire source lui-même). (Mes deux cents, c’est qu’il serait peut-être préférable que R-core déconseille officiellement (et finalement supprime) la vérification directe de la source plutôt que de nous confondre tous les initiés…)


13
2017-09-07 21:03