unit_options: Unit options.

In FIESTAutils: Utility Functions for Forest Inventory Estimation and Analysis

Unit options.

Description

Returns a list of user-supplied parameters and parameter values for unit.

Usage

unit_options(
  unitvar2 = NULL,
  areaunits = "acres",
  minplotnum.unit = 10,
  unit.action = "keep",
  npixelvar = "npixels",
  ...
)

Arguments

unitvar2	String. Name of a second level estimation unit variable in unitarea and cond or pltassgn with assignment for each plot (e.g., 'STATECD').
areaunits	String. Units of areavar in unitarea ('acres', 'hectares').
minplotnum.unit	Integer. Minimum number of plots for estimation unit.
unit.action	String. What to do if number of plots in an estimation unit is less than minplotnum.unit ('keep', 'remove' 'combine'). If unit.action='keep', estimation units with less that minplotnum.unit will be kept in output tables; if unit.action='remove', the estimation units with less that minplotnum.unit will be removed from the output tables; and if unit.action='combine', combines estimation unit to the following estimation unit, ordered in stratalut or unitzonal.
npixelvar	String. Name of variable in unitlut defining number of pixels by estimation unit.
...	For extendibility.

Details

If no parameters, an empty list is returned.

Value

A list of user-supplied parameters and parameter values for strata.

Author(s)

Grayson W. White

Examples

unit_options()

FIESTAutils documentation built on May 29, 2024, 4:06 a.m.