fireSense_dataPrepPredict/fireSense_dataPrepPredict.Rmd at main · PredictiveEcology/fireSense_dataPrepPredict · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
---
title: "fireSense_dataPrepPredict Manual"
subtitle: "v.`r SpaDES.core::moduleMetadata(module = 'fireSense_dataPrepPredict', 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_fireSense_dataPrepPredict.bib
link-citations: true
always_allow_html: true
---

# fireSense_dataPrepPredict Module

<!-- the following are text references used in captions for LaTeX compatibility -->
(ref:fireSense-dataPrepPredict) *fireSense_dataPrepPredict*

```{r setup-fireSense-dataPrepPredict, 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 = "fireSense_dataPrepPredict", path = '..')$authors), sep = ', ')`
<!-- ideally separate authors with new lines, '\n' not working -->

## Module Overview

### Module summary

<!-- TODO -->
fireSense [@Marchal:2017a; @Marchal:2017b; @Marchal:2019]

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("fireSense_dataPrepPredict", "..")` may be sufficient.

Table \@ref(tab:moduleInputs-fireSense-dataPrepPredict) shows the full list of module inputs.

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

Summary of user-visible parameters (Table \@ref(tab:moduleParams-fireSense-dataPrepPredict))


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

### Events

<!-- TODO -->
Describe what happens for each event type.

### Plotting

<!-- TODO -->
Write what is plotted.

### Saving

<!-- TODO -->
Write what is saved.

### Module outputs

Description of the module outputs (Table \@ref(tab:moduleOutputs-fireSense-dataPrepPredict)).

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

### Links to other modules

<!-- TODO: link to other fireSense modules -->
Describe any anticipated linkages to other modules, such as modules that supply input data or do post-hoc analysis.

### Getting help

- <https://github.com/PredictiveEcology/fireSense_dataPrepPredict/issues>

## References

<!-- autogenerated from bibligraphy -->