Как создать виньетку pdf в R и RStudio

Я новичок в написании пакетов R. Я пытаюсь научиться делать виньетку для своего пакета. Я создал папку виньеток с файлом "getting-started.Rmd"

---
title: "WaterML Tutorial"
author: "Jiri Kadlec"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Introduction to the WaterML R package}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

## Quick Start

This simple example shows how to get started with the <my R package>.

Для создания виньетки я использую команду:

devtools::build_vignettes()

Затем я запускаю Rcmd.exe INSTALL my_package и для просмотра своей виньетки запускаю:

browseVignettes("my_package")

Однако я вижу виньетки только в html и исходном формате: Я не вижу вариант pdf для виньеток

Как вы видите на скриншоте, опции «pdf» нет. Как настроить файл .Rmd для создания виньетки в формате pdf?


r pdf r-markdown knitr vignette
person jirikadlec2    schedule 24.06.2015    source источник
comment
Отвечает ли это на ваш вопрос? stackoverflow.com/questions/30936969/ или, возможно, попробуйте output:pdf_document?   -  person Ben Bolker    schedule 25.06.2015

Ответы (1)


arrow_upward
14
arrow_downward

В своем заголовке вы говорите R выводить только html-виньетку в строке:

output: rmarkdown::html_vignette

Если вы хотите pdf, попробуйте:

output: pdf_document

Согласно пакетам R:

Вывод: это сообщает rmarkdown, какой модуль форматирования вывода использовать. Есть много опций, полезных для обычных отчетов (включая html, pdf, слайд-шоу и т. д.), но rmarkdown::html_vignette специально разработан для работы внутри пакетов. См. ?rmarkdown::html_vignette для более подробной информации.

Таким образом, у вас могут возникнуть небольшие проблемы с использованием необработанного PDF-файла.

В настоящее время в rmarkdown нет опции output: rmarkdown::pdf_vignette.

person jeremycg    schedule 24.06.2015
comment
И нет необходимости иметь опцию output: rmarkdown::pdf_vignette (просто будет работать pdf_document). Причина html_vignette объясняется здесь: rmarkdown.rstudio.com/package_vignette_format.html - person Yihui Xie; 25.06.2015
comment
Хорошее объяснение. Итак, я вижу, что html_vignette является предпочтительным форматом в пакетах R, потому что его размер намного меньше. - person jirikadlec2; 27.06.2015