rmarkdown v0.1.2

0

Monthly downloads

0th

Percentile

R Markdown Document Conversion

Convert R Markdown documents into a variety of formats including HTML, MS Word, PDF, and Beamer.

Readme

Overview

The rmarkdown package is a next generation implementation of R Markdown based on pandoc. This implementation brings many enhancements to R Markdown, including:

  • Create HTML, PDF, and MS Word documents as well as Beamer ioslides and reveal.js presentations
  • New markdown syntax including expanded support for tables, definition lists, and bibliographies.
  • A responsive (multi-device friendly) and themeable HTML template based on Bootstrap 3.
  • Hooks for customizing HTML and PDF output (include CSS, headers, and footers).
  • Include raw LaTeX within markdown for advanced customization of PDF output.
  • Extensibility: easily define new formats for custom publishing requirements.

Note that creating PDF and Beamer output requires that LaTeX be installed.

Installation

To install the package and its dependencies:

devtools::install_github("rmarkdown", "rstudio")

A recent version of pandoc (>= 1.12.3) is also required. Recent daily builds of RStudio include pandoc v1.12.3. If you only intend to use the rmarkdown package within RStudio you can rely on this version.

If you are not running within RStudio then follow the pandoc installation instructions for your platform.

Usage

The render function is used to convert R Markdown (Rmd) files into various output formats (the default is HTML). Calling render will knit the specified input document and then produce the final output document using pandoc:

render("input.Rmd")

You can also specify a plain markdown file in which case knitting will be bypassed:

render("input.md")

Output Formats

R Markdown documents can contain a metadata section that includes both title, author, and date information as well as options for customizing output. For example, this metadata included at the top of an Rmd file adds a table of contents and chooses a different HTML theme:

---
title: "Sample Document"
output:
  html_document:
    toc: true
    theme: united
---

R Markdown has built in support for several output formats (HTML, PDF, and MS Word documents as well as Beamer presentations). These formats can also be specified in metadata, for example:

---
title: "Sample Document"
output:
  pdf_document:
    toc: true
    highlight: zenburn
---

If you aren't specifying format options you can also just use a simple format name:

---
title: "Sample Document"
output: pdf_document
---

Multiple formats can be specified in metadata:

---
title: "Sample Document"
output:
  html_document:
    toc: true
    theme: united
  pdf_document:
    toc: true
    highlight: zenburn
---

To select from the various formats defined you can pass a format name to render. For example:

render("input.Rmd", "pdf_document")

If no explicit format name is passed to render then the first one defined will be used.

Shared Output Formats

You can also define output formats externally in a file named output.yaml located in the same directory as the R Markdown source file. For example:

html_document:
  toc: true
  theme: united
pdf_document:
  toc: true
  highlight: zenburn

Using an output.yaml file is a good way to share output settings across multiple R Markdown files in the same directory.

Output Format Functions

Output formats need not be specified in metadata. In fact, metadata is just a convenient way to invoke functions that implement output formats. There are five built-in output formats each exported as a function from the package:

  • html_document
  • pdf_document
  • word_document
  • md_document
  • beamer_presentation
  • ioslides_presentation
  • revealjs_presentation

As you'd expect, these functions can also be invoked as part of the call to render, for example:

render("input.Rmd", html_document(toc = TRUE))
render("input.Rmd", pdf_document(latex_engine = "lualatex"))
render("input.Rmd", beamer_presentation(incremental = TRUE))

For more details on the options available for each format see their respective help topics.

License

The rmarkdown package is licensed under the GPLv3 (http://www.gnu.org/licenses/gpl.html).

Functions in rmarkdown

Name Description
beamer_presentation Convert to a Beamer presentation
ioslides_presentation Convert to an ioslides Presentation
knitr_options_html Knitr options for an HTML output format
includes Include content within output
md_document Convert to a markdown document
html_document Convert to an HTML document
knitr_options_pdf Knitr options for a PDF output format
output_format Define an R Markdown output format
default_output_format Determine the default output format for an R Markdown document
knitr_options Knitr options for an output format
pandoc_convert Convert a document with pandoc
pandoc_path_arg Transform path for passing to pandoc
pandoc_options Pandoc options for an output format
pandoc_available Check whether pandoc is available
render Render R Markdown
render_supporting_files Render supporting files for an input document
rmarkdown-package R Markdown Document Conversion
revealjs_presentation Convert to a reveal.js presentation
rmd_citations R Markdown Citations
rmd_metadata R Markdown Metadata
word_document Convert to an MS Word document
pandoc_args Functions for generating pandoc command line arguments
pdf_document Convert to a PDF document
rmarkdown_format R Markdown input format definition
No Results!

Last month downloads

Details

Type Package
Date 2014-01-17
SystemRequirements pandoc (>= 1.12.3) - http://johnmacfarlane.net/pandoc
License GPL-3

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/rmarkdown)](http://www.rdocumentation.org/packages/rmarkdown)