przy użyciu rmarkdown jako silnika winietowego

Question

Napisałem kilka winiet w R Markdown, z zamiarem posiadania ich zbudować z pakietu RStudio rmarkdown . Wiem, że rmarkdown::render jest funkcja używamy do konwertowania .rmd do .html (lub jakikolwiek inny format), jednakże, kiedy umieścić

<!-- 
%\VignetteEnginer{rmarkdown::render} 
%\VignetteIndexEntry{some test title} 
--> 

w preambule moim .rmd (i knitr i w moim Pole sugestii: DESCRIPTION, a także w polu VignetteBuilder) moja winieta nie jest kompilowana.

Czy ktoś zdołał uzyskać , aby działać jako budowniczy winiet?

Answer 1

Dlaczego chcesz używać zamiast knitr? Na pierwszy rzut oka twoje pytanie wygląda trochę na pomieszanie między a knitr. W celu wyjaśnienia:

rmarkdown to "format autorski", który jest "oparty na dzianinie i pandocie". Po uruchomieniu rmarkdown::render dzwonimy pod numer knitr i/lub pandoc.

knitr to silnik, który konwertuje rmarkdown na html/PDF/docx. To właśnie wykonuje kod R, aby uzyskać dane wyjściowe i wykresy, i tak dalej.

Autor paczki knitralready mentioned że "ponieważ pakiet rmarkdown nie jest jeszcze na CRAN, nie można w tej chwili używać silnika winietowania knitr :: rmarkdown". Jeśli nie możesz się doczekać, możesz register your own engine, ale wygląda to dość skomplikowanie.

myślę to, co chcesz:

Ten na górze doc RMD:

<!-- 
%\VignetteEngine{knitr::rmarkdown} 
%\VignetteIndexEntry{Supplementary materials} 
--> 

a to w pliku DESCRIPTION:

VignetteBuilder: knitr 
Suggests: 
    knitr 

Pełną przykład sprawdź tidyr package, tutaj jest DESCRIPTION i tutaj jest rmarkdown vignette (hat-tip do Andrie za skierowanie mnie do tego).

Jeśli jest coś konkretnego, czego potrzebujesz od , którego nie możesz uzyskać z knitr (niestandardowego stylu itp.), Powinieneś umieścić to w nowym pytaniu.

Answer 2

Biorąc od @ odpowiedź Bena (i komentarzach poniżej), knitrma zarejestrowany silnik winieta, która uzyskuje dostęp (jeśli jest zainstalowany) i

<!-- 
%\VignetteEngine{knitr::rmarkdown} 
%\VignetteIndexEntry{Supplementary materials} 
--> 

jest przykładem tego, jak chcemy go zarejestrować. Jednak, aby w pełni wykorzystać (czyli konwersja .Rmd „s do .html” s i zachowanie każdej stylizacji określonej w .Rmd) należy umieścić fragment kodu powyżej PONIŻEJ W «rmarkdown preambuły» .Jako przykład, szczyt swojej .Rmd powinien wyglądać

--- 
Title: "Supplementary Materials" 
output: 
    html_document: 
    theme: flatly 
--- 
<!-- 
%\VignetteEngine{knitr::rmarkdown} 
%\VignetteIndexEntry{Supplementary Materials} 
--> 

Oczywiście, należy również upewnić się, że prawidłowo utworzony plik OPIS zawierać i knitr. Najprostszym sposobem na to jest z

Suggests: knitr, rmarkdown 
VignetteBuilder: knitr