Как правильно организовать виньетки и папки inst при создании нового пакета R - PullRequest
Новая
       41

Как правильно организовать виньетки и папки inst при создании нового пакета R

2 голосов
/ 08 января 2020

Прежде чем спросить, я принимаю, что многие части этого вопроса были затронуты в другом стеке, и я прочитал разделы инстаграм и виньетки Хэдли Уикхэма, но я все еще пытаюсь исправить свои предупреждения. Извинения, если этот вопрос немного затянут, я постараюсь быть тщательным.

Моя проблема касается моего package_tutorial.

Первое предупреждение, которое я получаю, это: 

> checking files in ‘vignettes’ ... WARNING
  Files in the 'vignettes' directory but no files in 'inst/doc':
  ‘package_tutorial.Rmd’, ‘package_tutorial.pdf’

В документации Хэдли Уикхэма говорится: "inst / docs: это старое соглашение для виньеток, и его следует избегать в современных пакетах. " Так почему же проверка CMD запрашивает наличие виньеток в папке inst / do c? Я обрисую в общих чертах то, что находится в папке виньетки и инст в конце очереди.

Следующее предупреждение, которое я получу, будет следующим: 

> checking package vignettes in ‘inst/doc’ ... WARNING
  dir.exists(dir) is not TRUE
  Package vignette without corresponding single PDF/HTML:
     ‘package_tutorial.Rmd’

У меня нет дела c папка, потому что было ясно, что папка inst / do c устарела. Когда я проверяю CMD с моей виньеткой в ​​папке inst / do c, папка do c удаляется. Я понимаю, что это может быть частью процесса перестройки.

Дополнительная информация, которая может помочь решить эту проблему:

Создание папки (только для папок vignette и inst):

package - inst - extdata - package_tutorial.pdf

package - inst - extdata - package_tutorial.Rmd

package - inst - extdata - plots - несколько графиков, которые использует виньетка

package - vignettes - package_tutorial.pdf

package - vignettes - package_tutorial.Rmd

Я поиграл с различными вариантами отсутствия файлов Rmd в extdata и отсутствия файлов pdf в виньетках папка, но, увы, это не решило проблему.

Метаданные YAML: 

---
title: "package tutorial"
author: "Krutik Patel"
output:
        pdf_document: 
                keep_tex: true
                toc: true
                toc_depth: 5
                fig_width: 5
                fig_heigh: 4
                fig_caption: true
                df_print: kable 
                highlight: tango
                citation_package: natbib
vignette: >
        %\VignetteIndexEntry{package tutorial}
        %\VignetteEngine{knitr::rmarkdown}
        \usepackage[utf8]{inputenc}

Опции инструментов сборки: Build and Reload - R CMD INSTALL дополнительные опции: 

--no-multiarch --with-keep.source --resave-data

Проверьте пакет - R CMD УСТАНОВИТЕ дополнительные параметры: 

--as-cran --no-build-vignettes

Build Source Package - R CMD УСТАНОВИТЕ дополнительные параметры: 

--compact-vignettes="both"

Я надеюсь, что это Достаточно информации, чтобы помочь мне с моим вопросом. Я надеюсь, что это что-то глупое, чего я просто не видел. Любая помощь руководства очень ценится.

...