8 fireSense_EscapePredict Module
8.1 Module Overview
8.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.
8.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("fireSense_EscapePredict", "..") may be sufficient.
Table 8.1 shows the full list of module inputs.
| objectName | objectClass | desc | sourceURL |
|---|---|---|---|
| fireSense_EscapeFitted | fireSense_EscapeFit | An object of class fireSense_EscapeFit created with the fireSense_EscapeFit module. | NA |
| fireSense_IgnitionAndEscapeCovariates | data.frame | An object of class RasterStack or data.frame with prediction variables | NA |
| flammableRTM | SpatRaster | a raster with values of 1 for flammable pixels and 0 for nonflammable pixels | NA |
Summary of user-visible parameters (Table 8.3)
| paramName | paramClass | default | min | max | paramDesc |
|---|---|---|---|---|---|
| .runInitialTime | numeric | 0 | NA | NA | when to start this module? By default, the start time of the simulation. |
| .runInterval | numeric | 1 | NA | NA | optional. Interval between two runs of this module expressed in units of simulation time. By default, 1 year. |
| .saveInitialTime | numeric | NA | NA | NA | optional. When to start saving output to a file. |
| .saveInterval | numeric | NA | NA | NA | optional. Interval between save events. |
| .useCache | logical | FALSE | NA | NA | Should this entire module be run with caching activated? This is generally intended for data-type modules where stochasticity and time are not relevant |
8.1.6 Module outputs
Description of the module outputs (Table 8.5).
| objectName | objectClass | desc |
|---|---|---|
| fireSense_EscapePredicted | SpatRaster | A raster with values representing escape probability |
8.1.7 Links to other modules
Describe any anticipated linkages to other modules, such as modules that supply input data or do post-hoc analysis.