trList-class: Class '"trList"'

In cantonfe/sitree: Single Tree Simulator

Description

Describes the Reference Class trList, which is used to store data on live trees.

Extends

All reference classes extend and inherit methods from "envRefClass".

Fields

data:

Object of class list containing the unique stand ID (plot.id), the tree ID (treeid), and dbh (dbh.mm) and height (height.dm) for all the periods

nperiods:

Object of class integer containing the number of period that should be simulated

Methods

extractTrees(i):

Removes trees from the objectd, for example when trees die or are harvested

as.list():

converts this class to a list

show():

shows the first 20 trees

getTrees(i, j):

get the information for i trees and j periods without deleting the data

addTrees(value):

adds trees to the object

Note

trList objects should not be modified inside any user function. Any change should be made by the sitree function. Reference class objects are mutable, they don’t use R’s usual copy-on-modify semantics, but are modified in place. So, if you want to modify, for example for a posterior analysis of the results, any trList object I recommend to make a copy of the object first, using $copy(), e.g. my.tr.list$copy().

Author(s)

Clara Anton Fernandez [e-mail]

See Also

trListDead

Examples

showClass("trList")

cantonfe/sitree documentation built on Dec. 26, 2021, 8:55 a.m.