ssCellStemList-class {ssExtra}R Documentation

Class "ssCellStemList"

Description

This class is used in the simulation of big BAF sampling through the "ssBigBAF" class slots. It is a class that probably would not be used too much outside of the above or similar. It contains several lists and data frames that aid in working with tree-wise aggregates like tree VBARs on individual cells/points.

Objects from the Class

Objects can be created by calls of the form new("ssCellStemList", ...). However, it is simpler and less error-prone to use the constructor of the same name: ssCellStemList.

Slots

description:

Object of class "character" — A description of the object.

cellsInStems:

Object of class "list" — A list of cell numbers w/in each individual stem's inclusion zone.

stemsInCells:

Object of class "list" — A list of stem IDs whose inclusion zones overlap each individual cell—for all cells that contain inclusion zones. Note that background cells are excluded.

sumSIC:

Object of class "data.frame" — A summary data frame based on stemsInCells with the number of cells containing n stem inclusion zone overlaps.

sumCIS:

Object of class "data.frame" — A summary data frame based on cellsInStems with the number of stem inclusion zones containing n cells. This will normally be quite a bit longer than the sumSIC data frame.

cellIDs:

Object of class "character" — A vector of the cell IDs in the stemsInCells list.

cellNums:

Object of class "integer" — Integer version of cellIDs.

stemIDs:

Object of class "character" — A vector of the stem IDs in the cellsInStems list.

Methods

There are currently no methods defined with class "ssCellStemList" in the signature.

Author(s)

Jeffrey H. Gove

See Also

listCellStem

Examples

#
# if nhAll310.bb is an "ssBigBAF" object, then
#
## Not run: 
head(nhAll310.bb@csl.bb@cellsInStems)
length(nhAll310.bb@csl.bb@cellsInStems)
length(nhAll310.bb@csl.bb@stemsInCells)

## End(Not run) 

[Package ssExtra version 0.1-2 Index]