iterate: Get Candidate Sigmas and Sample Sizes

View source: R/iterate.R

iterateR Documentation

Get Candidate Sigmas and Sample Sizes

Description

Compare current sigmas and sample sizes with candidate values, by running variations of estSigmaR, estN, and estSigmaI on all model components.

Usage

iterate(model, ceiling=Inf, p=1, digits.n=0, digits.sigma=2)

Arguments

model

fitted scape model.

ceiling

largest possible sample size in one year, passed to estN.

p

effective number of parameters estimated in the model, passed to estSigmaI.

digits.n

number of decimal places to use when rounding sample sizes, or NULL to suppress rounding.

digits.sigma

number of decimal places to use when rounding sigmas, or NULL to suppress rounding.

Value

List containing data frames summarizing current sigmas and sample sizes, as well as candidate values. The following abbreviations are used in column names:

sigmahat

candidate sigma, the empirical standard deviation.

nhat

candidate sample sizes, the empirical multinomial sample sizes.

candbar

vector of candidate values, whose mean equals sigmahat or nhat.

candmed

vector of candidate values, whose median equals sigmahat or nhat.

candbar1

vector of identical candidate values, the mean of nhat.

candmed1

vector of identical candidate values, the median of nhat.

See Also

getN, getSigmaI, getSigmaR, estN, estSigmaI, and estSigmaR extract and estimate sample sizes and sigmas.

iterate combines all the get* and est* functions in one call.

scape-package gives an overview of the package.

Examples

iterate(x.cod)
iterate(x.ling)
iterate(x.oreo)
iterate(x.sbw)

arnima-github/scape documentation built on Jan. 17, 2024, 2:39 p.m.