---
title: "{{{name}}} Manual"
subtitle: "v.`r SpaDES.core::moduleMetadata(module = '{{{name}}}', path = '..')$version`"
date: "Last updated: `r Sys.Date()`"
output:
  bookdown::html_document2:
    toc: true
    toc_float: true
    theme: sandstone
    number_sections: false
    df_print: paged
    keep_md: yes
editor_options:
  chunk_output_type: console
bibliography: citations/references_{{{name}}}.bib
link-citations: true
always_allow_html: true
---

# {{{name}}} Module

<!-- the following are text references used in captions for LaTeX compatibility -->
(ref:{{{name2}}}) *{{{name}}}*

```{r setup-{{{name2}}}, include=FALSE}
knitr::opts_chunk$set(echo = TRUE, eval = FALSE, results = "hold") ## change to eval = TRUE if all chunks are to be evaluated

dir.create("figures", showWarnings = FALSE)

download.file(url = "https://img.shields.io/badge/Made%20with-Markdown-1f425f.png",
              destfile = "figures/markdownBadge.png",
              mode = "wb")
```

[![made-with-Markdown](figures/markdownBadge.png)](https://commonmark.org)

<!-- if knitting to pdf remember to add the pandoc_args: ["--extract-media", "."] option to yml in order to get the badge images -->

#### Authors:

`r paste(as.character(SpaDES.core::moduleMetadata(module = "{{{name}}}", path = '..')$authors), sep = ', ')`
<!-- ideally separate authors with new lines, '\n' not working -->

## Module Overview

### Module summary

Provide a brief summary of what the module does / how to use the module.

Module documentation should be written so that others can use your module.
This is a template for module documentation, and should be changed to reflect your module.

### Module inputs and parameters

Describe input data required by the module and how to obtain it (e.g., directly from online sources or supplied by other modules)
If `sourceURL` is specified, `downloadData("{{{name}}}", "{{{path}}}")` may be sufficient.

Table \@ref(tab:moduleInputs-{{{name2}}}) shows the full list of module inputs.

```{r moduleInputs-{{{name2}}}, echo = FALSE, eval = TRUE, message = FALSE, warning = FALSE}
df_inputs <- SpaDES.core::moduleInputs("{{{name}}}", "{{{path}}}")
knitr::kable(df_inputs,
             caption = "List of (ref:{{{name2}}}) input objects and their description.") |>
  kableExtra::kable_styling(latex_options = "scale_down", full_width = TRUE)
```

Summary of user-visible parameters (Table \@ref(tab:moduleParams-{{{name2}}}))


```{r moduleParams-{{{name2}}}, echo = FALSE, eval = TRUE, message = FALSE, warning = FALSE}
df_params <- SpaDES.core::moduleParams("{{{name}}}", "{{{path}}}")
knitr::kable(df_params, caption = "List of (ref:{{{name2}}}) parameters and their description.") |>
  kableExtra::kable_styling(latex_options = "scale_down", full_width = TRUE)
```

### Events

Describe what happens for each event type.

### Plotting

Write what is plotted.

### Saving

Write what is saved.

### Module outputs

Description of the module outputs (Table \@ref(tab:moduleOutputs-{{{name2}}})).

```{r moduleOutputs-{{{name2}}}, echo = FALSE, eval = TRUE, message = FALSE, warning = FALSE}
df_outputs <- SpaDES.core::moduleOutputs("{{{name}}}", "{{{path}}}")
knitr::kable(df_outputs, caption = "List of (ref:{{{name2}}}) outputs and their description.") |>
  kableExtra::kable_styling(latex_options = "scale_down", full_width = TRUE)
```

### Links to other modules

Describe any anticipated linkages to other modules, such as modules that supply input data or do post-hoc analysis.

### Getting help

-   provide a way for people to obtain help (e.g., module repository issues page)

## References

<!-- autogenerated from bibligraphy -->
