9 burnSummaries Module
9.1 Module Overview
9.1.1 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.
9.1.2 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("burnSummaries", "..") may be sufficient.
Table 9.1 shows the full list of module inputs.
| objectName | objectClass | desc | sourceURL |
|---|---|---|---|
| speciesLayers | RasterStack | initial percent cover raster layers used for simulation. | NA |
| speciesLayers | RasterStack | initial percent cover raster layers used for simulation. | NA |
Provide a summary of user-visible parameters (Table 9.2)
| paramName | paramClass | default | min | max | paramDesc |
|---|---|---|---|---|---|
| reps | integer | 1, 2, 3,…. | 1 | NA | number of replicates/runs per study area. |
| simOutputPath | character | /tmp/Rtm…. | NA | NA | Directory specifying the location of the simulation outputs. |
| upload | logical | FALSE | NA | NA | if TRUE, uses the googledrive package to upload figures. |
| uploadTo | character | NA | NA | NA | if upload = TRUE, a Google Drive folder id corresponding to .studyAreaName. |
| .plots | character | screen | NA | NA | Used by Plots function, which can be optionally used here |
| .plotInitialTime | numeric | 0 | NA | NA | Describes the simulation time at which the first plot event should occur. |
| .plotInterval | numeric | NA | NA | NA | Describes the simulation time interval between plot events. |
| .saveInitialTime | numeric | NA | NA | NA | Describes the simulation time at which the first save event should occur. |
| .saveInterval | numeric | NA | NA | NA | This describes the simulation time interval between save events. |
| .studyAreaName | character | NA | NA | NA | Human-readable name for the study area used - e.g., a hash of the studyarea obtained using reproducible::studyAreaName()
|
| .seed | list | NA | NA | Named list of seeds to use for each event (names). | |
| .useCache | logical | FALSE | NA | NA | Should caching of events or module be used? |
9.1.6 Module outputs
Description of the module outputs (Table 9.3).
| objectName | objectClass | desc |
|---|---|---|
| fireSizes | data.table | summary fire sizes table |