Skip to main content

fireSense Manual: v. 0.0.0.9000

4 fireSense_EscapeFit Module

made-with-Markdown

4.0.0.1 Authors:

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

4.1 Module Overview

Fit statistical models that can be used to parameterize the fire escape component of landscape fire models (e.g. fireSense (Marchal et al. 2017b, a; 2019)).

4.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.

4.1.2 Module inputs and parameters

Table 4.1 shows the full list of module inputs.

Table 4.1: Table 4.2: List of fireSense_EscapeFit input objects and their description.
objectName objectClass desc sourceURL
fireSense_escapeCovariates data.frame table of aggregated covariates with annual ignitions and escapes NA
fireSense_escapeFormula character a formula describing the model to be fitted, as character. NA

Summary of user-visible parameters (Table 4.3)

Table 4.3: Table 4.4: List of fireSense_EscapeFit parameters and their description.
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 NA NA NA optional. Interval between two runs of this module, expressed in units of simulation time. By default, NA, which means that this module only runs once per simulation.
.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.

4.1.3 Events

  • Module initialization;
  • Model fitting;

4.1.4 Plotting

Write what is plotted.

4.1.5 Saving

Write what is saved.

4.1.6 Module outputs

Description of the module outputs (Table 4.5).

Table 4.5: Table 4.6: List of fireSense_EscapeFit outputs and their description.
objectName objectClass desc
fireSense_EscapeFitted fireSense_EscapeFit formula - as a character - describing the model to be fitted.

4.2 References