Radix for R Markdown
This article is originally published at https://www.rstudio.com/blog/
Today we’re excited to announce Radix, a new R Markdown format optimized for scientific and technical communication. Features of Radix include:
Reader-friendly typography that adapts well to mobile devices.
Flexible figure layout options (e.g. displaying figures at a larger width than the article text).
Tools for making articles easily citeable, as well as for generating Google Scholar compatible citation metadata.
The ability to incorporate JavaScript and D3-based interactive visualizations.
A variety of ways to publish articles, including support for publishing sets of articles as a Radix website.
The ability to create a blog composed of a collection of Radix articles.
Radix is based on the Distill web framework, which was originally created for use in the Distill Machine Learning Journal. Radix combines the technical authoring features of Distill with R Markdown.
Below we’ll demonstrate some of the key features of Radix. To learn more about installing and using Radix, check out the Radix for R Markdown website.
Figure layout
Radix provides many flexible options for laying out figures. While the main text column in Radix articles is relatively narrow (optimized for comfortable reading), figures can occupy a larger region. For example:
For figures you want to emphasize or that require lots of visual space, you can also create layouts that occupy the entire width of the screen:
Of course, some figures and notes are only ancillary and are therefore better placed in the margin:
Citations and metadata
Radix articles support including citations and a corresponding bibliography using standard R Markdown citation syntax.
In addition, when you provide a citation_url metadata field for your article, a citation appendix that makes it easy for others to cite your article is automatically generated:
Radix also automatically includes standard Open Graph and Twitter Card metadata. This makes links to your article display rich metadata when shared in various places:
Creating a blog
You can publish a series of Radix articles as either a website or a blog. For example, the TensorFlow for R blog is implemented using Radix:
To learn more, see the article on creating a blog with Radix.
Getting started
To create an R Markdown document that uses the Radix format, first install the radix R package:
devtools::install_github("rstudio/radix")
Using Radix requires Pandoc v2.0 or higher. If you are using RStudio then you should use RStudio v1.2.718 or higher (which comes bundled with Pandoc v2.0). You can download the preview release of RStudio v1.2 at https://www.rstudio.com/products/rstudio/download/preview/.
Next, use the New R Markdown dialog within RStudio to create a new Radix article:
This will give you a minimal new Radix document.
Then, check out the Radix for R Markdown website to learn more about what’s possible. Happy authoring!
Thanks for visiting r-craft.org
This article is originally published at https://www.rstudio.com/blog/
Please visit source website for post related comments.
