Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eddelbuettel/tint
Tint is not Tufte
https://github.com/eddelbuettel/tint
cran markdown r-package vignette
Last synced: 11 days ago
JSON representation
Tint is not Tufte
- Host: GitHub
- URL: https://github.com/eddelbuettel/tint
- Owner: eddelbuettel
- Created: 2016-09-18T19:28:03.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-13T11:25:57.000Z (4 months ago)
- Last Synced: 2024-10-12T21:26:08.060Z (29 days ago)
- Topics: cran, markdown, r-package, vignette
- Language: R
- Homepage:
- Size: 7.09 MB
- Stars: 261
- Watchers: 15
- Forks: 25
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
Awesome Lists containing this project
- jimsghstars - eddelbuettel/tint - Tint is not Tufte (R)
README
## tint: Tint is not Tufte
[](https://github.com/eddelbuettel/tint/actions?query=workflow%3Aci)
[](https://www.gnu.org/licenses/gpl-3.0.html)
[](https://cran.r-project.org/package=tint)
[](https://cran.r-project.org/package=tint)
[](https://www.r-pkg.org/pkg/tint)
[](https://github.com/eddelbuettel/tint)
### Motivation
The (html and pdf) styles provided by the [tufte](https://cran.r-project.org/package=tufte) package
make it very easy and convenient to create documents in the celebrated style of
[Edward Tufte](https://www.edwardtufte.com/tufte/).
The clear layout, focused use of white space and unparalleled use of the margin for complementary
information, including graphs, offer a novel and very valuable resource for typesetting.
Yet at the same time, not everybody is a fan of the yellow tint, and the fonts. I had been looking
for a while for an alternative, and came across
[envisioned css](https://github.com/nogginfuel/envisioned-css) by Jef Lippiat. It gets a few things
very right: use of the beautiful
[Roboto Condensed font](https://fonts.google.com/specimen/Roboto+Condensed) along with
a closer-to-white background. So I _mixed_ this with the code framework provided by JJ and Yihui to
make it an [RMarkdown](https://rmarkdown.rstudio.com/) template you can use just by installing this
package. Among the small changes I made were the removal of _italics_ in subheaders and the title.
Similarly, LaTeX styles exists and the
[tufte](https://cran.r-project.org/package=tufte) package supports both pdf
handouts and a book format. We first supported the pdf handout
output only, and added support for a pdf book format in release 0.1.0.
### Example
#### HTML
A quick screenshot of the html variant is below:
and the full underlying document is [available too](https://eddelbuettel.github.io/tint/). Its sources
are included in the packages as
[html/skeleton.Rmd](https://github.com/eddelbuettel/tint/blob/master/inst/rmarkdown/templates/tintHtml/skeleton/skeleton.Rmd).
#### PDF
Another screenshot shows the pdf handout variant:
and its underlying sources are included as
[pdf/skeleton.Rmd](https://github.com/eddelbuettel/tint/blob/master/inst/rmarkdown/templates/tintPdf/skeleton/skeleton.Rmd).
Here is a screenshot of the book format (which was added with release 0.1.0), showing a chapter-opening page on the left:
#### PDF Font Variants
Since release 0.1.1 additional fonts can be specified in the YAML header. Using the following lines
in the YAML header
```yaml
latexfonts:
- package: newtxmath
options:
- cmintegrals
- cmbraces
- package: ebgaramond-maths
- package: nimbusmononarrow
```
yields output as in the following screenshot of the first two vignette pages:
A second example is using
```yaml
latexfonts:
- package: lato
options: default
- package: FiraMono
linkcolor: "0.3,0.3,0.6"
```
which also show the `linkcolor` option resulting in
### Status
The package is now on [CRAN](https://cran.r-project.org/package=tint) and
supports both pdf and html output for handouts, as well as pdf format for
book-length documents. This latter style can be used with `rmarkdown` or
`bookdown`.
### Usage
Install from [CRAN](https://cran.r-project.org) as any other package via
```r
R> install.packages("tint")
```
and then use as a Markdown template via RStudio, or call `rmarkdown::render()` directly.
We have also used the book-length format via `bookdown::render_book()`.
### Requirements
Beyond the R package dependencies, a working `pandoc` binary is needed. RStudio installs
its own copy, otherwise do what is needed on your OS (_i.e._, something like `sudo apt-get
install pandoc pandoc-citeproc`).
The pdf mode requires a fairly complete LaTeX installation. On Debian/Ubuntu, the
following packages should provide a working set:
```
texlive-base
texlive-binaries
texlive-fonts-extra
texlive-fonts-recommended
texlive-generic-recommended
texlive-humanities
texlive-latex-base
texlive-latex-extra
texlive-latex-recommended
texlive-pictures
```
### See Also
#### Other RMarkdown Packages
- [binb](https://github.com/eddelbuettel/binb): Binb is not Beamer: Stylish pdf Presentations from RMarkdown
- [linl](https://github.com/eddelbuettel/linl): Linl is not Letter: LaTeX letters from RMarkdown
- [pinp](https://github.com/eddelbuettel/pinp): Pinp is not PNAS: Snazzy one-or two column short papers or vignettes
and the [minm](https://github.com/eddelbuettel/minm) package installing all of them.
#### Sidenotes
[Gwern Branwen](https://www.gwern.net/index) has a wide-ranging overview of [sidenotes in web design](https://www.gwern.net/Sidenotes).
### Authors
Dirk Eddelbuettel and Jonathan Gilligan, borrowing heavily from JJ and Yihui in
[tufte](https://cran.r-project.org/package=tufte), Dave Liepman in the underlying
[tufte-css](https://github.com/edwardtufte/tufte-css), Jef Lippiat in
[envisioned css](https://github.com/nogginfuel/envisioned-css) and also relying on the work
of the [Tufte-LaTeX](https://tufte-latex.github.io/tufte-latex/) authors.
### License
GPL-3 for our parts and the code from [tufte](https://cran.r-project.org/package=tufte),
mostly MIT for what comes from Dave Liepman and Jef Lippiat.