Analysis Functions

These functions are used to conduct inventory analysis with allometric models and inspect their contents.

install_models()

Install allometric models from the models repository

load_models()

Load a locally installed table of allometric models

predict()

Predict with an allometric model

predict_allo()

Predict allometric attributes using a column of allometric models

model_call()

Get the function call for a model

select_model()

Select an allometric model

select_model(<model_tbl>)

Select a model from allometric_models

merge(<model_tbl>)

Merge a model_tbl with another data frame.

check_models_installed()

Check if allometric models are currently installed

Searching Functions

These functions facilitate searching models, especially those that assist with filtering for species information stored in the Taxa and Taxon classes.

unnest_models()

Unnest columns of a dataframe

unnest_models(<model_tbl>)

Unnest the columns of model_tbl

unnest_taxa()

Unnest the taxa column of a model_tbl

unnest_taxa(<model_tbl>)

Unnest the taxa column of a model_tbl

`%in%`(<Taxon>,<character>)

Check if a Taxon contains a character

`%in%`(<Taxa>,<character>)

Check if a Taxa contains a character

`%in%`(<character>,<Taxon>)

Check if a character is in a Taxon

`%in%`(<character>,<Taxa>)

Check if a character is in a Taxa

`%in%`(<Taxa>,<Taxon>)

Check if a Taxa is in Taxon

`%in%`(<Taxon>,<Taxa>)

Check if a Taxon is in a Taxa

Contributor Functions

These functions are used to contribute models to allometric.

add_model()

Add a model to a publication

add_set()

Add a set of models to a publication

aggregate_taxa()

Aggregate family, genus, and species columns of `tbl_df`` into taxa data structure

get_variable_def()

Get the definition of a variable in the variable naming system.

get_component_defs()

Load the component definitions

get_measure_defs()

Load the measure definitions

FixedEffectsModel()

Create a fixed effects model

FixedEffectsSet()

Create a set of fixed effects models

MixedEffectsModel()

Create a mixed effects model

MixedEffectsSet()

Create a set of mixed effects models

Publication()

Create a publication that contains allometric models

`==`(<FixedEffectsModel>,<FixedEffectsModel>)

Check equivalence of fixed effects models

`==`(<MixedEffectsModel>,<MixedEffectsModel>)

Check equivalence of mixed effects models

Taxa()

Group taxons together

Taxon()

Create a taxonomic hierarchy

`%in%`(<Taxon>,<character>)

Check if a Taxon contains a character

toJSON(<FixedEffectsModel>)

Convert a fixed effects model to a JSON representation

toJSON()

Convert a model or publication to a JSON representation

Example Data

Example data included with allometric.

fia_trees

FIA Trees Data

brackett_acer

Brackett Acer Volume Model

brackett_rubra

An object of class FixedEffectsModel

Package Summary

allometric allometric-package

allometric: Structured Allometric Models for Trees