Forest Informed Neural Networks


[Up] [Top]

Documentation for package ‘FINN’ version 0.2.0

Help Pages

ALE Accumulated local effect plots
apply_env_scaling Apply stored z-standardization to environmental predictors
array2obsDF Transform Arrays to Observation Data Table
averageConditionalEffects Average conditional effects of a FINN model
BA_stand Calculate the Basal Area of a Stand
BA_stem Calculate the basal area of a tree given the diameter at breast height (dbh)
binomial_from_bernoulli Draw binomial counts from per-trial Bernoulli probabilities
climateDF2array Convert a climate data frame to a FINN environment array
CohortMat Cohort Matrix Class
comparePlot Compare a simulation with observations
competition Compute the fraction of available light (light) for each cohort based on the given parameters
compute_env_scaling Compute per-predictor environmental scaling
conditionalEffects Conditional effects of a FINN model
createHybrid Define a hybrid (deep-neural-network) demographic process for FINN
createProcess Define a demographic process for FINN
dbh2ba Convert DBH to basal area
evaluate Evaluate a fitted model
feature_importance Permutation feature importance for FINN demographic rates
fia_env_dt Oregon FIA calibration data: site climate
fia_env_test Oregon FIA calibration data: site climate
fia_init_test Oregon FIA calibration data: initial tree list
fia_init_trees Oregon FIA calibration data: initial tree list
fia_obs_dt Oregon FIA calibration data: training sites
fia_obs_test Oregon FIA calibration data: training sites
fia_species_dt Oregon FIA calibration data: species coding
fia_tree_dt Oregon FIA calibration data: the trees behind the mortality counts
fia_tree_test Oregon FIA calibration data: the trees behind the mortality counts
finn Build a FINN forest model
finn-data The input tables of FINN: observations, environment, initial trees
finn-loss How fit() compares the simulation with the observations: the loss
FINN-recruitment Recruitment in FINN: the options and how to choose them
FINN.seed Set Seed for Reproducibility in R and Torch
finnControl Settings of the optimizer used by fit()
finn_data The input tables of FINN: observations, environment, initial trees
finn_loss How fit() compares the simulation with the observations: the loss
fit Estimate the parameters of a FINN model
growth Growth
height Calculate the height of a tree based on its diameter at breast height and an allometry parameter
makeInitCohorts Make initial cohorts for FINN
makeObsData Create observation data from trees
mortality Mortality
obsDF2arrays Convert a cohort table to arrays
plot.FINNale Plot ALE curves of a FINN model
plot.finn_class Plot the fitted parameters of a FINN model
plot.finn_evaluation Evaluate a fitted model
plot.finn_simulation Plot a FINN simulation
pred2DF Convert Prediction Arrays to Data Frames
predict.finn_class Simulate a forest with a FINN model
predictTrees Predict growth and mortality for individual observed trees
print.finnControl Settings of the optimizer used by fit()
print.finn_comparison Compare a simulation with observations
print.finn_evaluation Evaluate a fitted model
print.finn_heatmap Compare a simulation with observations
print.finn_simulation Plot a FINN simulation
print.summary.finn_class Summarise a fitted FINN model
recruitment Recruitment in FINN: the options and how to choose them
regeneration Regeneration without a recruitment cap
regeneration_adult Regeneration limited by conspecific adult density
regeneration_adult_effect Regeneration with an effect of conspecific adult density
regeneration_capped Regeneration with a Beverton-Holt recruitment cap
regeneration_saturation Regeneration with a Beverton-Holt recruitment cap
resolveSiteIDs Resolve site, patch, and year indices for FINN inputs
rweibull_cohorts Generate Cohorts Using Weibull Distribution
simulateForest Simulate a forest with a FINN model
summary.finn_class Summarise a fitted FINN model