| title | fireSense_dataPrepPredict Manual | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| subtitle | v.1.0.1 | ||||||||||||||
| date | Last updated: 2025-04-08 | ||||||||||||||
| output |
|
||||||||||||||
| editor_options |
|
||||||||||||||
| bibliography | citations/references_fireSense_dataPrepPredict.bib | ||||||||||||||
| link-citations | true | ||||||||||||||
| always_allow_html | true |
(ref:fireSense-dataPrepPredict) fireSense_dataPrepPredict
Ian Eddy ian.eddy@nrcan-rncan.gc.ca [aut, cre], Eliot McIntire eliot.mcintire@nrcan-rncan.gc.ca [aut], Alex M Chubaty achubaty@for-cast.ca [ctb]
fireSense [@Marchal:2017a; @Marchal:2017b; @Marchal:2019]
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.
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_dataPrepPredict", "..") may be sufficient.
Table @ref(tab:moduleInputs-fireSense-dataPrepPredict) shows the full list of module inputs.
| objectName | objectClass | desc | sourceURL |
|---|---|---|---|
| climateVariablesForFire | list | A list detailing which climate variables in `sim$projectedClimateRasters` to use for which fire processes (ignition and spread). If the list is length one, both processes will use the same variables. The default is to use 'MDC'. | NA |
| cohortData | data.table | table that defines the cohorts by pixelGroup | NA |
| flammableRTM | SpatRaster | RTM without ice/rocks/urban/water. Flammable map with 0 and 1. | NA |
| nonForestedLCCGroups | list | a named list of non-forested landcover groups, e.g. `list('wetland' = c(19, 23, 32))`. This is only relevant if `landcoverDT` is not supplied | NA |
| nonForest_timeSinceDisturbance | SpatRaster | time since burn for non-forested pixels | NA |
| pixelGroupMap | SpatRaster | SpatRaster that defines the pixelGroups for cohortData table | NA |
| projectedClimateRasters | list | list of projected climate variables in raster stack form named according to variable, with names of individual raster layers following the convention 'year<year>' | NA |
| landcoverDT | data.table | data.table with `pixelID` and relevant landcover classes | NA |
| rasterToMatch | SpatRaster | template raster used only to derive `flammableRTM` if the latter is absent | NA |
| rstCurrentBurn | SpatRaster | binary raster with 1 representing annual burn | NA |
| rstLCC | SpatRaster | a landcover raster - only used if `landcoverDT` is not supplied | NA |
| sppEquiv | data.table | table of LandR species equivalencies | NA |
Summary of user-visible parameters (Table @ref(tab:moduleParams-fireSense-dataPrepPredict))
| paramName | paramClass | default | min | max | paramDesc |
|---|---|---|---|---|---|
| cutoffForYoungAge | numeric | 15 | NA | NA | Age at and below which pixels are considered 'young' (i.e., `age <= cutoffForYoungAge`). |
| fireTimeStep | numeric | 1 | NA | NA | time step of fire model |
| forestedLCC | numeric | 81, 210,.... | NA | NA | forested landcover classes in `rstLCC` - only relevant if `landcoverDT` is not supplied |
| ignitionFuelClassCol | character | FuelClass | NA | NA | the column in sppEquiv that defines unique fuel classes for ignition |
| missingLCCgroup | character | nonFores.... | NA | NA | if a pixel is forested but is absent from `cohortData`, it will be grouped in this class. Must be one of the names in `sim$nonForestedLCCGroups`. |
| nonflammableLCC | numeric | 20, 31, .... | NA | NA | used to create flammableRTM if unsupplied. The non-flammable LCC in rstLCC layers - which default to water, snow/ice, rock, and barren land in NTEMS LCC |
| nonForestCanBeYoungAge | logical | TRUE | NA | NA | update non-forest when burned, to become youngAge |
| sppEquivCol | character | LandR | NA | NA | column name in `sppEquiv` object that defines unique species in `cohortData` |
| spreadFuelClassCol | character | FuelClass | NA | NA | if using fuel classes for spread, the column in sppEquiv that defines unique fuel classes |
| whichModulesToPrepare | character | fireSens.... | NA | NA | Which fireSense fit modules to prep? defaults to all 3 |
| .plotInitialTime | numeric | NA | 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. |
| .runInitialTime | numeric | 0 | NA | NA | time to simulate initial fire |
| .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. |
| .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 |
Describe what happens for each event type.
Write what is plotted.
Write what is saved.
Description of the module outputs (Table @ref(tab:moduleOutputs-fireSense-dataPrepPredict)).
| objectName | objectClass | desc |
|---|---|---|
| currentClimateRasters | list | list of project climate rasters at current time of sim |
| fireSense_IgnitionAndEscapeCovariates | data.table | data.table of covariates for ignition prediction, with pixelID column corresponding to flammableRTM pixel index |
| fireSense_SpreadCovariates | data.table | data.table of covariates for spread prediction, with pixelID column corresponding to flammableRTM pixel index |
| nonForest_timeSinceDisturbance | SpatRaster | time since burn for non-forest pixels |
Describe any anticipated linkages to other modules, such as modules that supply input data or do post-hoc analysis.