| climateScenario |
character |
NA |
NA |
NA |
Name of the CMIP6 climate scenario including SSP, formatted as in ClimateNA, e.g. ‘CanESM5_SSP370’. Used in figure filenames (multi mode). |
TRUE |
| mode |
character |
single |
NA |
NA |
‘single’: run within a simulation, saving burnMap and burnSummary at end(sim). ‘multi’: summarize the saved outputs of several replicates in figures. |
TRUE |
| simOutputPath |
character |
/tmp/Rtm…. |
NA |
NA |
Directory holding the replicate output directories, and where figures are written (multi mode). |
TRUE |
| .runName |
character |
NA |
NA |
NA |
Name of this run, e.g. ‘13.1_NRV_370_1’; names its metrics file (fireSenseUtils::ELFmetricsFilename()). NA: the name of outputPath(sim). |
TRUE |
| studyAreaName |
character |
NA |
NA |
NA |
Study area name; used in figure paths and filenames (multi mode). |
TRUE |
| reps |
integer |
1, 2, 3,…. |
1 |
NA |
Replicate numbers to summarize (multi mode). Files are read with mclapply; set options(mc.cores = ) to run in parallel. |
TRUE |
| escapeSizeHa |
numeric |
50 |
0 |
NA |
Fire size (ha) counted as an escape in the hindcast (nFires50); as in the fit. |
TRUE |
| hindcastInterval |
numeric |
1 |
0 |
NA |
Hindcast: time between the simulated rep-years. A job for year Y runs times Y, Y + interval, …; rep = round((time - hindcastYear) / interval) + 1. Set it to the predict modules’ interval (e.g. 0.001). |
TRUE |
| hindcastYear |
integer |
NA |
NA |
NA |
Hindcast validation: the observed year the simulated rep-years are compared with. NA (default): no hindcast. Single mode records each rep-year and, at end(sim), writes hindcast_reps.csv, hindcast_sizes.csv, hindcast_observed.csv, hindcast_observedSizes.csv, hindcast_observedPolys.gpkg, hindcast_observedPoints.gpkg, hindcast_burnMap.tif and, per rep, hindcast_burnID_rep<rep>.tif, hindcast_ignitionProb_rep<rep>.tif and hindcast_escapeProb_rep<rep>.tif. Multi mode pools the replicate folders (parameter sets) in hindcast figures instead of the usual multi-mode figures. |
TRUE |
| years |
integer |
NA, NA |
NA |
NA |
Which two simulation years should be compared? Typically start and end years. Defaults to the simulation’s own start and end times. |
TRUE |