Minimal Example of Tutorial as R package vignette

This example illustrates the required metadata by andrew for a tutorial written as pkgdown vignette, based on R Markdown(Xie, Allaire, and Grolemund 2018) which is an extension to Markdown(Gruber 2004).

Markdown

andrew uses Quarto and pkgdown uses R Markdown to convert Markdown to HTML.

Although footnotes are supported, the use of footnotes is discouraged¹.

Math can be written using LaTeX and is render by MathJax. Both inline, for example \(x\), and standalone, for example \[x = \sqrt{a^2 + b^2}\text{,}\] is supported.

R Markdown does not support cross-references like (sec-markdown?).

R Markdown supports code execution .

Execution of R code

R code can be executed and the output can be included inline, for example 1 + 1 is equal to 2, and standalone, for example

a <- 1
b <- 1

a + b
#> [1] 2

Annotation of code blocks is also supported. For example,

(3 %/% 2) != (3 %% 2) # <1>

%% calculates the remainder on integer division.

Execution of R code from package

library(mwe)

hello()
#> [1] "Hello"

Creation of figure with R

plot(runif(10, min=0, max=10), type='l')

Binder

The link to Binder will launch RStudio IDE.

Binder uses the information in runtime.txt to launch RStudio IDE.

References

Gruber, John. 2004. “Markdown: Syntax.” Daring Fireball. https://daringfireball.net/projects/markdown/syntax.

Xie, Y., J. J. Allaire, and G. Grolemund. 2018. R Markdown: The Definitive Guide. Chapman & Hall/CRC the r Series. CRC Press.