Documentation

The documentation is built with R Markdown and hosted with Github Pages.

R Markdown is an awesome tool that features:

• knitr: an R engine for embedding code chunks in Markdown files.
• pandoc: a universal document convertor.

For more details, refer to R Markdown: The Definitive Guide or bookdown.

Installation

In your R console run the following code.

install.packages('bookdown')

# For PDF output install TinyTeX
install.packages("tinytex")
tinytex::install_tinytex()

Usage

# Generate book.pdf (via LaTeX)
make pdf

# Generate index.html
make html

Directory Content

docs/
├── img/            # Image dir
├── include/        # TeX and HTML options
├── parts/          # Markdown content
├── _bookdown.yml   # bookdown options
├── _output.yml     # rmd output options
├── book.pdf        # PDF output
├── index.html      # HTML output
├── main.rmd        # main MD file
├── Makefile
└── README.md