README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# RMDs4NMU

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![CRAN status](https://www.r-pkg.org/badges/version/RMDs4NMU)](https://CRAN.R-project.org/package=RMDs4NMU)
<!-- badges: end -->

RMDs4NMU provides an R Markdown template for creating written student assignments. I uses the excellent [LaTeX exam package](https://ctan.org/pkg/exam).

## Installation

You can install the development version of RMDs4NMU from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("sjvrensburg/RMDs4NMU")
```

In RStudio, after installation, you can create an assignment by following these simple instructions:

1. Select File > New File > R Markdown
2. Select From Template
3. Select assignment in the list of templates.

## Roadmap

Future versions my include:

- Other templates, including quizzes, slides and exams.
- Examples and a tutorial.