R/frame.R

#' frame: Fire Research and Modelling Environment
#' 
#' This package provides an interface to the Forest Flammability Model of
#' Zylstra et al, adding functions for complex fire simulation and first-order 
#' fire effects modelling. It provides  the primary functions required to prepare input 
#' parameters, run model simulations, and query the output database of model results,
#' as well as introducing complex simulations. First-order effects models are provided
#' for plant canopies, stems, and soil effects.
#' 
#' The package includes a distribution of the model and its dependencies in the
#' form of Java jar files. The only additional requirement is an installation
#' of Java version 1.8 (aka Java 8) or higher on the host system.
#'
#' @references
#' Zylstra, P. J., Bradstock, R. A., Bedward, M., Penman, T. D., Doherty, M. D., 
#' Weber, R. O., … Cary, G. J. (2016). Biophysical mechanistic modelling quantifies 
#' the effects of plant traits on fire severity: species, not surface fuel loads 
#' determine flame dimensions in eucalypt forests. PLoS One, 11(8), e0160715. 
#' doi:10.1371/journal.pone.0160715
#' 
#' Zylstra P. J. (2020) Linking fire behaviour and its ecological effects to 
#' plant traits, using FRaME in R. Methods Ecol. Evol., In Review
#'
#' @docType package
#' @name frame
#'
NULL
pzylstra/frame_r documentation built on Nov. 12, 2023, 1:55 a.m.