strata_options {FIESTAutils}

Strata options.

Description

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

Usage

strata_options(
  getwt = FALSE,
  getwtvar = "P1POINTCNT",
  strwtvar = "strwt",
  stratcombine = TRUE,
  minplotnum.strat = 2,
  pivot = FALSE,
  nonresp = FALSE,
  ...
)

Arguments

getwt

Logical. If TRUE, calculates strata weights from stratatlut getwtvar. If FALSE, strwtvar variable must be in stratalut.

getwtvar

String. If getwt=TRUE, name of variable in stratalut to calculate weights (Default = 'P1POINTCNT').

strwtvar

String. If getwt=FALSE, name of variable in stratalut with calculated weights (Default = 'strwt').

stratcombine

Logical. If TRUE, and strata=TRUE, automatically combines strata categories if less than minplotnum.strat plots in any one stratum. See notes for more info.

minplotnum.strat

Integer. Minimum number of plots for a stratum within an estimation unit.

pivot

Logical. If TRUE, pivot stratalut.

nonresp

Deprecated.

...

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

strata_options(getwt = FALSE)