Skip to main content

fireSense Manual: v. 0.0.0.9000

7 fireSense_IgnitionPredict Module

made-with-Markdown

7.0.0.1 Authors:

Jean Marchal [aut], Eliot McIntire [aut], Ian Eddy [aut, cre], Alex M Chubaty [ctb]

7.1 Module Overview

7.1.1 Module summary

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 et al. 2017b, a; 2019)).

7.1.2 Module inputs and parameters

Table 7.1 shows the full list of module inputs.

Table 7.1: Table 7.2: List of fireSense_IgnitionPredict input objects and their description.
objectName objectClass desc sourceURL
covMinMax_ignition data.table Table of the original ranges (min and max) of covariates NA
fireSense_IgnitionFitted fireSense_IgnitionFit An object of class fireSense_IgnitionFit created with the fireSense_IgnitionFit module. NA
fireSense_IgnitionAndEscapeCovariates data.table An object of class SpatRaster (named according to variables) or data.frame/data.table with prediction variables. If a data.frame/data.table, then a column named ‘pixelID’ needs to be supplied NA
fireSense_IgnitionAndEscapeCovariates SpatRaser An object of class SpatRaster (named according to variables) or data.frame/data.table with prediction variables. If a data.frame/data.table, then a column named ‘pixelID’ needs to be supplied NA
flammableRTM SpatRaster OPTIONAL. A raster with values of 1 for every flammable pixel, required if is(fireSense_IgnitionAndEscapeCovariates, 'data.table'). NA

Summary of user-visible parameters (Table 7.3)

Table 7.3: Table 7.4: List of fireSense_IgnitionPredict parameters and their description.
paramName paramClass default min max paramDesc
ignitionFit_Predict_Package character glmmTMB NA NA The package used to fit the ignitionFit model. It wil be loaded using Require.
.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

7.1.3 Events

  • Module initialization;
  • Make predictions;

7.1.4 Plotting

Write what is plotted.

7.1.5 Saving

Write what is saved.

7.1.6 Module outputs

Description of the module outputs (Table 7.5).

Table 7.5: Table 7.6: List of fireSense_IgnitionPredict outputs and their description.
objectName objectClass desc
fireSense_IgnitionPredicted SpatRaster a raster layer of ignition probabilities

7.2 References