10 fireSense_hindcast Module

10.0.0.1 Authors:

Alex M Chubaty [aut, cre]

10.1 Module Overview

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

10.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)

Table 10.1 shows the full list of module inputs.

Table 10.1: Table 10.2: List of fireSense_hindcast input objects and their description.
objectName objectClass desc sourceURL
historicalClimateRasters list named list of SpatRasters of historical climate variables. list named after the variable and raster layers named as year<numeric year> NA
projectedClimateRasters list named list of SpatRasters of projected climate variables. list named after the variable and raster layers named as year<numeric year> NA

Provide a summary of user-visible parameters (Table 10.3)

Table 10.3: Table 10.4: List of fireSense_hindcast parameters and their description.
paramName paramClass default min max paramDesc cacheKey
.plots character screen NA NA Used by Plots function, which can be optionally used here TRUE
.plotInitialTime numeric 0 NA NA Describes the simulation time at which the first plot event should occur. TRUE
.plotInterval numeric NA NA NA Describes the simulation time interval between plot events. TRUE
.saveInitialTime numeric NA NA NA Describes the simulation time at which the first save event should occur. TRUE
.saveInterval numeric NA NA NA This describes the simulation time interval between save events. TRUE
.studyAreaName character NA NA NA Human-readable name for the study area used - e.g., a hash of the studyarea obtained using reproducible::studyAreaName() TRUE
.seed list NA NA Named list of seeds to use for each event (names). TRUE
.useCache logical FALSE NA NA Should caching of events or module be used? TRUE

10.1.3 Events

Describe what happens for each event type.

10.1.4 Plotting

Write what is plotted.

10.1.5 Saving

Write what is saved.

10.1.6 Module outputs

Description of the module outputs (Table 10.5).

Table 10.5: Table 10.6: List of fireSense_hindcast outputs and their description.
objectName objectClass desc
historicalClimateRasters list named list of SpatRasters of historical climate variables. list named after the variable and raster layers named as year<numeric year>
projectedClimateRasters list named list of SpatRasters of resampled historic climate variables. list named after the variable and raster layers named as year<numeric year>