| title | fireSense_SpreadPredict Manual | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| subtitle | v.0.0.1 | ||||||||||||||
| date | Last updated: 2025-04-08 | ||||||||||||||
| output |
|
||||||||||||||
| editor_options |
|
||||||||||||||
| bibliography | citations/references_fireSense_SpreadPredict.bib | ||||||||||||||
| link-citations | true | ||||||||||||||
| always_allow_html | true |
(ref:fireSense-SpreadPredict) fireSense_SpreadPredict
Jean Marchal jean.d.marchal@gmail.com [aut], Eliot McIntire eliot.mcintire@nrcan-rncan.gc.ca [aut, cre], Tati Michelleti tati.micheletti@gmail.com [aut], Ian Eddy ian.eddy@nrcan-rncan.gc.ca [aut], Alex M. Chubaty achubaty@for-cast.ca [ctb]
Predicts a surface (raster) of fire spread probabilities using a model previously fit with fireSense_SpreadFit.
fireSense [@Marchal:2017a; @Marchal:2017b; @Marchal:2019]
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_SpreadPredict", "..") may be sufficient.
Table @ref(tab:moduleInputs-fireSense-SpreadPredict) shows the full list of module inputs.
| objectName | objectClass | desc | sourceURL |
|---|---|---|---|
| covMinMax_spread | data.table | range used to rescale coefficients during spreadFit | NA |
| fireSense_SpreadCovariates | data.table | data.table of covariates with pixelID column corresponding to flammableRTM index. | NA |
| fireSense_SpreadFitted | fireSense_SpreadFit | An object of class 'fireSense_SpreadFit' created by the fireSense_SpreadFit module. | NA |
| flammableRTM | SpatRaster | RTM with nonflammable pixels coded as 0 and flammable as 1. | NA |
Summary of user-visible parameters (Table @ref(tab:moduleParams-fireSense-SpreadPredict))
| paramName | paramClass | default | min | max | paramDesc |
|---|---|---|---|---|---|
| climCol | character | MDC | NA | NA | the name of the climate covariate in `sim$fireSense_spreadCovariates` |
| coefToUse | character | meanCoef | NA | NA | Which coefficient to use to predict? The best coefficient (bestCoef) from DEOPtim or the average (meanCoef; default). |
| lowerSpreadProb | numeric | 0.13 | NA | NA | Lower spread probability |
| mutuallyExclusiveCols | list | vegPC | NA | NA | a named list, where the name of the list must be a covariate in the data.table. Covariates matching the values in each list element will be set to 0. List content should be a grep regex. |
| .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.Defaults to 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 |
- Module initiation;
- Make predictions.
Write what is plotted.
There is currently nothing saved, but this may change in the future.
Description of the module outputs (Table @ref(tab:moduleOutputs-fireSense-SpreadPredict)).
| objectName | objectClass | desc |
|---|---|---|
| fireSense_SpreadPredicted | SpatRaster | A raster layer of spread probabilities |
Predictions made with this module can be used with the fire spread component of landscape fire models (e.g., fireSense).