In parsermd: Formal Parser and Related Tools for R Markdown Documents

This is an example of using knitr with extended markdown (e.g. GFM) and uploading images to imgur.com automatically. Note you should set the graphical device to create images that can be displayed in the web browser, e.g. dev = 'png' (it is the default for markdown output) works but 'pdf' does not.

First, the input file was named as knitr-upload.Rmd (source), and knitr will automatically determine the output filename to be knitr-upload.md.

I used the code below to make sure knitr will upload images and set some global chunk options.

library(knitr)
opts_knit$set(upload.fun = imgur_upload, base.url = NULL) # upload all images to imgur.com
opts_chunk$set(fig.width=5, fig.height=5, cache=TRUE)

Now we write some code chunks in this markdown file:

## a simple calculator
1+1
## boring random numbers
set.seed(123)
rnorm(5)

We can also produce plots which are uploaded to imgur.com:

par(mar = c(4, 4, .1, .1))
plot(mpg~hp, data=mtcars, pch=19)
par(mar = c(3, 2, .1, .1))
matplot(t(scale(mtcars)), lty=1, type='l', xaxt='n', ylab='')
axis(1, seq(ncol(mtcars)), colnames(mtcars))

So knitr is ready with GitHub with a single markdown file.

parsermd documentation built on May 20, 2021, 5:08 p.m.