The rmdNMUsimple package provides reliable, minimal R Markdown templates for Nelson Mandela University documents. This package represents a fundamental architectural redesign prioritising compilation stability and cross-platform compatibility over advanced typographical features.
The package adopts a pragmatic approach to academic document production, emphasising:
- Reliability: Consistent compilation across diverse LaTeX installations
- Simplicity: Minimal dependencies and straightforward template architecture
- Maintainability: Reduced complexity for sustainable long-term support
- Compatibility: Standard pdflatex engine support without exotic requirements
The predecessor rmdNMU package, whilst feature-rich, suffered from critical reliability issues:
Pandoc Compatibility Problems: Complex LaTeX template architecture proved vulnerable to Pandoc version updates, resulting in frequent compilation failures and maintenance overhead.
LaTeX Engine Dependencies: The package's reliance on XeLaTeX created barriers for users with standard LaTeX installations, particularly in managed computing environments.
Font Management Complexity: Sophisticated font installation procedures and cross-platform path resolution introduced failure points that compromised user experience.
Package Conflict Resolution: Extensive conditional package loading and duplicate command definitions generated LaTeX compilation errors requiring constant maintenance.
The rmdNMUsimple package addresses these limitations through architectural simplification:
- Standard pdflatex compilation engine compatibility
- Reduced dependency requirements (rmarkdown, bookdown only)
- Simplified LaTeX template structure without complex conditionals
- Standard font handling without custom installation procedures
The package remains available exclusively through GitHub, with no planned CRAN release:
# Install from GitHub repository
if (!require(devtools)) install.packages("devtools")
devtools::install_github("sjvrensburg/rmdNMUsimple")- R (≥ 3.5.0)
- LaTeX distribution with pdflatex support
- rmarkdown and bookdown packages
The package provides three core template types:
| Template | Function | Purpose |
|---|---|---|
| NMU Beamer Slides | nmu_beamer() |
Academic presentations |
| NMU General Document | nmu_document() |
Notes, assignments, reports |
| NMU Assessment | nmu_assessment() |
Tests, examinations |
NMU Branding: Consistent application of university colours (blue #141c2b, yellow #ffce00) across all template types.
Sans-serif Typography: Global sans-serif font application including mathematical notation via the sansmath package.
Enhanced Environments: Support for styled note, warning, and example boxes through Lua filter processing.
The simplification process necessitated removing several advanced features:
Typography: No custom font integration; standard system fonts replace NMU's official Nunito Sans typeface.
Faculty Theming: Colour schemes are limited to primary NMU branding without faculty-specific variations.
Advanced Environments: Complex theorem environments require manual formatting or conversion to basic box environments.
TikZ Integration: Advanced graphics packages are not pre-configured, though users may add them manually.
Important: This package does not implement NMU's official Nunito Sans font family. Documents utilise standard sans-serif fonts available across LaTeX installations. Institutions requiring strict brand compliance should consider this limitation when adopting the package.
When using captions with kable(), avoid underscores in chunk labels:
✅ Good: {r datatable}, {r summaryinfo}
❌ Bad: {r data_table}, {r summary_info}
This prevents cross-reference processing conflicts.
Submit issues through the GitHub repository: https://github.com/sjvrensburg/rmdNMUsimple/issues
The package welcomes contributions that maintain the core philosophy of simplicity and reliability. Please ensure all modifications preserve cross-platform compatibility and minimal dependency requirements.
License: GNU General Public License (≥ 3)
Author: Dr Stefan Janse van Rensburg
Institution: Department of Statistics, Nelson Mandela University
Contact: stefanj@mandela.ac.za
This package prioritises reliable document production over advanced typographical features, providing a stable foundation for academic content creation within the NMU Statistics Department.