Skip to content

Unofficial MAX PLANCK INSTITUTE RMarkdown templates and ggplot themes

License

Notifications You must be signed in to change notification settings

Ehyaei/MPIThemes

Repository files navigation

logo with an image of a MPI Templates

MPIThemes

R build status

RMarkdown enables you to write reproducible academic publications such as articles, PhD thesis, lab reports, posters, presentations, and a variety of other fascinating documents using the lightweight and plain-text Markdown syntax.

In the Rmarkdown environment, you can write text, insert images, formulas and simultaneously R and Python scripts.

MPIThemes is not only for R users!. Python programmers can also run codes in Rmarkdown. This article has additional information.

When running your Rmd files with knitr, output plots, tables and code results are embedded in the md file. Then, Rstudio by using pandoc’s powerful engine can convert your documents to many formats, such as PDF, Docx, HTML, epub, and… In particular, you can create PDF reports without worrying about the lateX code.

The MPIThemes package’s objective is to provide a wide range of Rmarkdown templates with ggplot themes for scientific reproducible research with custom design for the MAX-PLANCK institute. For designing report templates, I found the CD manual (available here)

The manual sets out the standards for writing reports for Max-Planck society. The title page, logo, size, colors, and font guidelines are all described in this document. I attempted to meet the guidelines, but it still does not fully comply.

Features

The MPIThemes package contains report and presentation templates in PDF, HTML, Office formats. In the articles area, you’ll find an introduction to each template as well as instructions on how to config it. The templates that have been implemented so far are as follows:

The template’ default format is based on the Maxi-Planck theme. We weren’t, however, constrained by this theme. Reports in various styles can be created by defining the relevant parameters in YAML or templates. for more details see PDF Report Template Customization

Installation

MPIThemes is not (yet) available on CRAN, so install development version from GitHub via the devtools or remotes packages.

🛑 🚧 Before installing the package, you should check that you have X11 plotting device and Univers font on your machine. The font source can be found here. For more details on package dependencies, see Get Started.

# install.packages("devtools")
devtools::install_github("Ehyaei/MPIThemes")

Example Gallery

PDF, HTML, and Office outputs are all supported by the template. Some Design can be found in the examples section. The full document details may be found by clicking on the image.

Comments and bug reports are welcome. Please submit a bug report or a pull request to the Github repository. The following templates will be gradually added to the bundle.

Attribution

The RMarkdown packages and latex resources that inspired this effort include: