https://github.com/rstudio/tufte

Tufte Styles for R Markdown Documents
https://github.com/rstudio/tufte

r-markdown r-package tufte tufte-style

Last synced: 3 days ago
JSON representation

Tufte Styles for R Markdown Documents

• Host: GitHub
• URL: https://github.com/rstudio/tufte
• Owner: rstudio
• Created: 2016-01-06T06:17:45.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2023-06-23T07:24:27.000Z (over 1 year ago)
• Last Synced: 2024-10-05T04:14:42.444Z (about 1 month ago)
• Topics: r-markdown, r-package, tufte, tufte-style
• Language: R
• Homepage: https://rstudio.github.io/tufte/
• Size: 1.4 MB
• Stars: 399
• Watchers: 26
• Forks: 110
• Open Issues: 20
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - rstudio/tufte - Tufte Styles for R Markdown Documents (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# tufte

[![CRAN status](https://www.r-pkg.org/badges/version/tufte)](https://CRAN.R-project.org/package=tufte)

[![Downloads from the RStudio CRAN mirror](https://cranlogs.r-pkg.org/badges/tufte)](https://cran.r-project.org/package=tufte)

[![R-CMD-check](https://github.com/rstudio/tufte/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rstudio/tufte/actions/workflows/R-CMD-check.yaml)

[![Codecov test coverage](https://codecov.io/gh/rstudio/tufte/branch/main/graph/badge.svg)](https://app.codecov.io/gh/rstudio/tufte?branch=main)

This R package provides a few R Markdown output formats that use the Tufte style. See  for a comprehensive example.

## Books



See about the Tufte Handouts format in R Markdown Definitive Guide

## Installation

You can install the last available released version from [CRAN](https://cran.r-project.org/package=tufte)

``` r

install.packages('tufte')

```

You can also install the development version of **tufte** from [GitHub](https://github.com/) with:

``` r

# install.packages("pak")

pak::pak("rstudio/tufte")

```

## Usage

The easiest way to make a new R Markdown document using Tufte style is from within RStudio. Go to _File > New File > R Markdown > From template > Tufte Handout_.

This can also be created from the command line using

```r

rmarkdown::draft("tufte.Rmd", "tufte_html", "tufte")

```

## Getting help

There are two main places to get help:

1. The [RStudio community](https://community.rstudio.com/c/r-markdown/10) is a friendly place to ask any questions about rmarkdown and the R Markdown family of packages. Use tag **tufte** in your post.

1. [Stack Overflow](https://stackoverflow.com/questions/tagged/r-markdown+tufte) is a great source of answers to common rmarkdown questions. It is also a great place to get help, once you have created a reproducible example that illustrates your problem.