| title | fireSense_IgnitionPredict Manual | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| subtitle | v.0.2.0 | ||||||||||||||
| date | Last updated: 2025-04-08 | ||||||||||||||
| output |
|
||||||||||||||
| editor_options |
|
||||||||||||||
| bibliography | citations/references_fireSense_IgnitionPredict.bib | ||||||||||||||
| link-citations | true | ||||||||||||||
| always_allow_html | true |
(ref:fireSense-IgnitionPredict) fireSense_IgnitionPredict
Jean Marchal jean.d.marchal@gmail.com [aut], Eliot McIntire eliot.mcintire@nrcan-rncan.gc.ca [aut], Ian Eddy ian.eddy@nrcan-rncan.gc.ca [aut, cre], Alex M Chubaty achubaty@for-cast.ca [ctb]
Predicts fire frequency or rates of fire counts using a model fitted with the fireSense_IgnitionFit module.
Use them to feed the ignition component of a landscape fire model (e.g fireSense [@Marchal:2017a; @Marchal:2017b; @Marchal:2019]).
Table @ref(tab:moduleInputs-fireSense-IgnitionPredict) shows the full list of module inputs.
| objectName | objectClass | desc | sourceURL |
|---|---|---|---|
| NA | NA | NA | NA |
Summary of user-visible parameters (Table @ref(tab:moduleParams-fireSense-IgnitionPredict))
| paramName | paramClass | default | min | max | paramDesc |
|---|---|---|---|---|---|
| .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? |
- Module initialization;
- Make predictions;
Write what is plotted.
Write what is saved.
Description of the module outputs (Table @ref(tab:moduleOutputs-fireSense-IgnitionPredict)).
| objectName | objectClass | desc |
|---|---|---|
| NA | NA | NA |
Predictions made with this module can be used to feed the ignition component of a landscape fire model (e.g fireSense).