hist-methods {sampSurf}R Documentation

Methods for graphics Function hist in Package sampSurf

Description

The methods described here are for the hist generic as used in the sampSurf package. Several of the methods shown below have different arguments that customize each for a different class of objects found in this package. Method dispatch is based on the signature x argument.

Methods

Some arguments that are in the graphics::hist method are given default values in the calls below. Please refer to the graphics documentation for details.

signature(x = "downLogs")

Creates a histogram of any one of several down log attributes in the container collection as specified by the logAttr argument.

usage...

hist(x, 
     logAttr = c('logLen','buttDiam','topDiam','logAngle','solidType','logVol',
                 'surfaceArea','coverageArea','biomass','carbon'),
     xlab = logAttr,
     main = NA,
     col = 'gray90',
     ... )
signature(x = "standingTrees")

Creates a histogram of any one of several standing tree attributes in the container collection as specified by the treeAttr argument.

usage...

hist(x, 
     treeAttr = c('height','buttDiam','dbh','topDiam','solidType','treeVol',
                  'surfaceArea','biomass','carbon'),
     xlab = treeAttr,
     main = NA,
     col = 'gray90',
     ... )
signature(x = "izContainer")

Creates a histogram of inclusion zone areas for the objects in the container—this will work for all subclasses of “izContainer”.

usage...

hist(x, 
     xlab = 'Inclusion Zone Area',
     main = NA,
     col = 'gray90',
     ... )
signature(x = "InclusionZoneGrid")

Creates a histogram of the desired attribute for the object. Please note that it is not uncommon for the surface to be flat, which means all grid cells have the same value, so that a histogram is really meaningless. Use this on classes of objects where the surface (attribute estimate) varies within an individual inclusion zone.

usage...

hist(x,
     zeroTrunc = TRUE,
     estimate = 'volume',
     main = NA,
     xlab = NA,
     col = 'gray90',
     ... )
signature(x = "sampSurf")

Creates a histogram of the sampling distibution of the surface from the individual cell values.

usage...

hist(x, 
     zeroTrunc = TRUE,
     xlab = x@estimate,
     main = NA,
     col = 'gray90',
     ... )

Monte Carlo methods

signature(x = "mcsContainer")

Histograms of the relative error or volume variance over the collection are supported. Please note that this method applies to objects of class “antitheticContainer” as well.

usage...

hist(x,
     stat = c('relErrPct', 'volVar'),
     xlab = stat,
     main = NA,
     col = 'gray90',
     ... )

[Package sampSurf version 0.7-5 Index]