title	subtitle	date	output	editor_options	bibliography	citation-style	link-citations	always_allow_html
burnSummaries Manual	v.1.0.0	Last updated: 2025-04-07	bookdown::html_document2 toc toc_float toc_depth theme number_sections df_print keep_md true true 4 sandstone false paged true	chunk_output_type markdown console wrap 80	citations/references_burnSummaries.bib	citations/ecology-letters.csl	true	true

burnSummaries Module

(ref:burnSummaries) burnSummaries

(ref:percent) %

Authors:

Alex M Chubaty [email protected] [aut, cre] (https://orcid.org/0000-0001-7146-8135)

:::{.rmdwarning} This documentation is work in progress. Please report any discrepancies or omissions at https://github.com/PredictiveEcology/BC_HRV_preamble/issues. :::

Module Overview

Module summary

(TODO)

• LandMine [@Andison:1996] - based on [@Clarke:1994];
• scfm [@Cumming:1998; @Armstrong:2003];
• fireSense [@Marchal:2017a; @Marchal:2017b; @Marchal:2019]

Module inputs and parameters

Table @ref(tab:moduleInputs-burnSummaries) shows the full list of module inputs.

(\#tab:moduleInputs-burnSummaries)(\#tab:moduleInputs-burnSummaries)List of (ref:burnSummaries) input objects and their description.

objectName	objectClass	desc	sourceURL
speciesLayers	SpatRaster	initial percent cover raster layers used for simulation.	NA

Provide a summary of user-visible parameters (Table @ref(tab:moduleParams-burnSummaries))

(\#tab:moduleParams-burnSummaries)(\#tab:moduleParams-burnSummaries)List of (ref:burnSummaries) parameters and their description.

paramName	paramClass	default	min	max	paramDesc
reps	integer	1, 2, 3,....	1	NA	number of replicates/runs per study area.
simOutPrefix	character	mySimOut	NA	NA	saved simList file prefix
simOutputPath	character	/var/fol....	NA	NA	Directory specifying the location of the simulation outputs.
simTimes	numeric	NA, NA	NA	NA	Simulation start and end times when running in 'multi' mode.
upload	logical	FALSE	NA	NA	if TRUE, uses the `googledrive` package to upload figures.
uploadTo	character	NA	NA	NA	if `upload = TRUE`, a Google Drive folder id corresponding to `.studyAreaName`.
.plots	character	screen	NA	NA	Used by Plots function, which can be optionally used here
.plotInitialTime	numeric	0	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.
.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.
.studyAreaName	character	NA	NA	NA	Human-readable name for the study area used - e.g., a hash of the studyarea obtained using `reproducible::studyAreaName()`
.seed	list		NA	NA	Named list of seeds to use for each event (names).
.useCache	logical	FALSE	NA	NA	Should caching of events or module be used?

Events

Describe what happens for each event type.

Plotting

Write what is plotted.

Saving

Write what is saved.

Module outputs

Description of the module outputs (Table @ref(tab:moduleOutputs-burnSummaries)).

(\#tab:moduleOutputs-burnSummaries)(\#tab:moduleOutputs-burnSummaries)List of (ref:burnSummaries) outputs and their description.

objectName	objectClass	desc
fireSizes	data.table	summary fire sizes table

Links to other modules

Describe any anticipated linkages to other modules, such as modules that supply input data or do post-hoc analysis.

Getting help

• https://github.com/PredictiveEcology/burnSummaries/issues

References