Man pages for pzylstra/frame_r
Fire Research and Modelling Environment

ausTraitTableConstructs a default.species.params table using traits...
baseDynBuilds models for top-base height allometry dynamics of...
boleAir temperature above ambient at the tree bole behind the...
buildFloraConstructs the table F_flora from formatted survey data
buildFloraPCreates an 'F_flora' table for FRaME from plant modelling
buildParamsConstructs parameter files from imported tables
buildSiteMetaBuilds the dataframe site.meta from input tables Building...
buildSpeciesValuesBuilds the dataframe species.values from input tables...
buildStrataMetaBuilds the dataframe strata.meta from input tables Compatible...
buildStructureConstructs the table F_structure from formatted survey data
buildStructurePCreates an 'F_structure' table for FRaME from plant modelling
buildStructurePPCreates an 'F_structure' table for FRaME from plant modelling...
buildTraitsPCreates traits table for FRaME from plant modelling
burnPrintFinds the area burned and effects of a fire
cambiumFinds radial bole necrosis depth
canopyCheckModifies inputs ensuring params file fits criteria
climDynamicsModels input weather parameters from a climate dataset, each...
collectTraitsPCreates traits table for FRaME from plant modelling
conDriversModels fire behaviour across defined slopes and DFMCs, with...
coverDynBuilds models for cover dynamics of surveyed Species
ctrlDiversityRemoves leaf trait diversity
datCleanPerforms basic data checks on survey data, fixes or removes...
driversModels fire behaviour across ranged variables
driversFrameModels fire behaviour across ranged variables using species...
driversRandModels fire behaviour across ranged variables using species...
driversSModels fire behaviour across ranged variables using species...
drysideCalculates likelihood of basal scarring on a tree
ffm_assemble_tableAssembles a parameter table from a list of elements.
ffm_check_javaCheck for a locally installed Java runtime system
ffm_check_paramsChecks that a parameter table is complete
ffm_complete_paramsCompletes a table by adding default parameters for each...
ffm_db_loadAttempts to load the entire contents of a database into the R...
ffm_db_summarySummarize the contents of a model results database.
ffm_describe_betasGenerates example Beta distributions.
ffm_disassemble_tableDisassembles a parameter table into a list of components.
ffm_param_infoRetrieves information for a parameter label.
ffm_param_table_summaryReturns a summary of the given parameter table.
ffm_param_varianceRandomly perturbs values for selected numeric parameters in a...
ffm_read_legacy_paramsReads a legacy format parameters file
ffm_runRun the model with a given table of parameters.
ffm_run_commandComposes a command line call to run a simulation
ffm_run_robustModifies inputs until model runs Discontinued
ffm_set_site_paramSets the value of a site meta-data parameter.
ffm_set_species_paramSets the value of a species parameter.
ffm_set_stratum_paramSets the value of a stratum meta-data parameter.
ffm_valid_paramChecks that a parameter label is valid.
ffm_write_paramsWrites a table of parameters to a CSV format file.
fireDynamicsModels fire behaviour across multiple ages on parallel cores...
firePlantModels fire behaviour across a range of ages from plant...
fireSetModels fires using sites constructed from imported tables
floraScorch height using an isotherm
floraDynamicsBuilds the plant growth table used in dynamic modelling
floraTargetScorch height using an isotherm, including target species
frameframe: Fire Research and Modelling Environment
frameDynTabConstructs an age sequence of parameter files built from...
frameRiskFind likelihood and consequence of death for canopy trees
frameSpreadFinds distance of fire spread for a part of a landscape
frameStratifyArranges survey data into strata using k-means clustering
frameSummarySummary table of fire behaviour
frameSummaryBetaSummary table of fire behaviour, beta version
frameSurveyProcesses field survey data into tables formatted for fire...
frameTablesConstructs parameter files for FRaME using outputs from plant
frameWeatherFormats hourly weather data for frame, with DFMC
girdleFinds radial bole necrosis depth, dividing bark into four...
growPlantsGrows a table of species to a given age, listing cover and...
heDynBuilds models for top-he height allometry dynamics of...
hollowFire risk for an animal sheltering in a wooden hollow
htDynBuilds models for top-ht height allometry dynamics of...
ignitionsFinds randomised lightning ignition time and location
ignitionTempPSFACalculates ignition temperature from proportion of silica...
insolFinds solar radiation reaching the ground surface
kWoodThermal conductivity of dry wood
LAIcommCalculates LAI for a horizontal slice of a plant community
LAIcommXTitle
LAIpCalculates LAI for a slice of a plant
litterModels the weight of surface litter from time since fire...
mammalFire risk for an exposed arboreal mammal
mRSEFinds the RSE for the mean of a vector
paramBuilderConstructs parameter files from formatted datasets
ParamInfoValid parameters and their default units.
parBurnPInternal function for fireDynamics Calculate fire dynamics...
parBurnPWInternal function for fireDynamics Calculate fire dynamics...
parBurnWInternal function for fireDynamics Calculate fire dynamics...
parClimInternal function for climDynamics
parRiskInternal function for riskDynamics
pBasePredicts plant base height at a given age
pCoverPredicts proportion cover at a given age
pHePredicts plant He at a given age
phiConfiguration or view factor
pHtPredicts plant Ht at a given age
plantFlameCollects flame segments for a specified plant in a stratum
plantRiskCalculates risk (likelihood & consequence) for plants in a...
plantVarRandomly modifies plant traits within defined ranges for...
plantVarFrameRandomly modifies plant traits within defined ranges for...
plantVarSRandomly modifies plant traits within defined ranges for...
probFireModels probabilistic fire behaviour
probFire_FrameModels probabilistic fire behaviour using species-specific...
profileDetCalculates a vertical wind profile
pseudoTransectCreates a dataset of plants with expected size and cover...
pTopPredicts plant top height at a given age
pWidthPredicts plant crown width at a given age
readLegacyParamFileReads a legacy format parameters file.
repFlameRepresentative flame descriptors
richFinds the distribution of species richness at a point
richSFinds the distribution of species richness per stratum
riskDynamicsCalculates forest risk parameters over a growth series using...
riverSupport function to randomise river width
simplefmcFinds the moisture content of dead leaf litter at a given...
siteBuilderBuilds the dataframe site.meta from input tables
soilSoil heating
spCombModels fire behaviour in each species of a parameter table,...
specCoverFinds percent cover of surveyed Species and groups minor...
speciesSpecies descriptors from a param file
speciesBuilderBuilds the dataframe species.values
speciesDropRemoves identified species from a param file and tidies the...
specPointSelects random species from the available list, weighted by...
spotFireCalculates spotting distance
standardiseNamesAdds standardised names to a table of field data
strataStratum descriptors from a param file
strataBuilderBuilds the dataframe strata.meta
stratRichCalculates the range, mean and sd of species richness in each...
stratSiteDivides site data into consecutively numbered strata with...
stratTestStratum test
stratTestXStratum test FAULTY, DON'T USE
stratumSummary table of stratum results
summaryDiscontinued version of summary table of fire behaviour
surfSummary table of surface results
suspFinds the height of near-surface litter
tauAtmospheric attenuation
threatCalculates the convective and radiative heat from a flame...
tidyWeatherHelper function for frameWeather
topDynBuilds models for top height dynamics of surveyed Species
transectLongCombines multiple transects into one
undergroundFire risk for an animal sheltering underground
unitBuilderFormats units for parameter files
updateSpeciesUpdates species names from an optional table
updateTraitsChecks traits table for column names and adds data from a new...
wDynBuilds models for top-w height allometry dynamics of surveyed...
weatherSetUpdates parameter files with weather from a dataset, then...
weatherSet_FrameUpdates parameter files with weather from a dataset, then...
weatherSetSUpdates parameter files with weather from a dataset, then...
windReductionFinds the Wind Reduction Factor for a param file
pzylstra/frame_r documentation built on Nov. 12, 2023, 1:55 a.m.