rolldown v0.1

0

Monthly downloads

0th

Percentile

R Markdown Output Formats for Storytelling

R Markdown output formats based on JavaScript libraries such as 'Scrollama' (<https://github.com/russellgoldenberg/scrollama>) for storytelling.

Readme

rolldown

Travis build status Lifecycle: Experimental

Rolldown is an R Markdown extension that builds scroll-driven HTML documents for storytelling, a.k.a scrollytelling, powered by JavaScript libraries. Currently, only Scrollama is supported.

Installation

# Install from GitHub
remotes::install_github("yihui/rolldown")

Get started

You can get started with some built-in R Markdown templates in this package. If you use the RStudio IDE, you can create a new R Markdown document from File -> New File -> R Markdown -> From Template. Then find a rolldown template from the list. If you do not use RStudio, you may use the rmarkdown::draft() function to create a new R Markdown document, e.g.,

rmarkdown::draft('story.Rmd', template = 'scrollama-document', package = 'rolldown')

Functions in rolldown

Name Description
scrollama R Markdown output formats for using Scrollama
No Results!

Vignettes of rolldown

Name
scrollama-basic.Rmd
scrollama-sidebar.Rmd
No Results!

Last month downloads

Details

Type Package
License MIT + file LICENSE
Encoding UTF-8
LazyData true
RoxygenNote 6.1.1
VignetteBuilder knitr
NeedsCompilation no
Packaged 2019-07-09 13:54:26 UTC; yihui
Repository CRAN
Date/Publication 2019-07-14 23:00:03 UTC

Include our badge in your README

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