ftt_treesize: Create an 'ftt_treesize' object

Description Usage Arguments Value

View source: R/classes.R

Description

Create an ftt_treesize object

Usage

1
2
3
4
5
6
7
8
9
ftt_treesize(
  data = NULL,
  dbh = "dbh",
  height = "height",
  crown = "crown",
  crown_radius = "crown_radius",
  ...,
  translate_colors = FALSE
)

Arguments

data

Optionally, a data frame containing all the data necessary to create an ftt_treesize object. If NULL, all other arguments are interpreted as data to use in constructing the object; if not NULL, arguments are interpreted as the names of columns in data containing the values for each slot.

dbh

Numeric: diameter at breast height, in meters. May include missing values, which will be handled differently by different rendering functions.

height

Numeric: bole height, in meters. May include missing values, which will be handled differently by different rendering functions. Height is understood as the total height of the object to be rendered (top of the stem and crown, if applicable); different importer functions may determine this differently.

crown

Logical: does the tree have leaves? May include missing values, which will be handled differently by different rendering functions.

crown_radius

Numeric: radius of the crown, in meters, at its widest point. May include missing values, which will be handled differently by different rendering functions.

...

Additional arguments passed to mvdf::mvdf_simple_material.

translate_colors

Passed to mvdf::mvdf_simple_material (but included as a separate argument to help with auto-complete).

Value

An object of class ftt_treesize.


mikemahoney218/blender-forthetrees documentation built on Dec. 24, 2021, 1:27 a.m.