allometries_description: Info for allometries

View source: R/lfcAllometries.R

allometries_descriptionR Documentation

Info for allometries

Description

allometries_description is a wrapper for the $description method of lfcAllometries objects. See also allometries.

Usage

allometries_description(object, ..., id = NULL)

Arguments

object

lfcAllometries object, as created by allometries

...

Expresions resolving to a logical value to filter the allometries. Only evaluated if id is NULL.

id

Character vector with the allometry/ies id

Value

A list with the selected allometries and their info, see examples. In the special case of no id or expressions (...) provided, information for all the allometries is returned.

See Also

Other Allometries functions: allometries_calculate(), allometries_get_data(), allometries()

Examples


if (interactive()) {
  # by id
  allomdb <- allometries()
  foo <- allometries_description(allomdb, id = "GC_3210")
  foo
  foo$GC_3210$dependent_var
  foo$GC_3210$param_a

  # filtering
  ht_dn_allometries <- allometries_description(allomdb, dependent_var %in% c("GC", "Dn"))
  length(ht_dn_allometries)
  names(ht_dn_allometries)
  ht_dn_allometries$GC_3210$dependent_var
  ht_dn_allometries$GC_3210$param_a
}


MalditoBarbudo/lfcdata documentation built on May 2, 2023, 10:30 p.m.