NormalFixed: Specify a model based on a normal distribution with known...

View source: R/SpecModel-generators.R

NormalFixedR Documentation

Specify a model based on a normal distribution with known means and standard deviations.

Description

Specify a model of the form

y_i = N(mean[i], sd[i])

or

y_i = N(exposure[i] * mean[i], sd[i])

.

Usage

NormalFixed(mean, sd, useExpose = TRUE)

Arguments

mean

An object of class Values holding means.

sd

The standard deviation of the means. sd can be an object of class Values, or it can be a single number, in which case it is applied to all elements of mean.

useExpose

Whether the model includes an exposure term. Defaults to TRUE.

Details

Among other things, the model is useful as a data model for surveys. In such cases, exposure represents the true underlying counts, mean represents coverage rates, sd represents standard errors for the coverage rates, and y represents the observered counts. If the model is being used to represent a census post-enumeration survey, for instance, then exposure would be the true population, mean the coverage rates as estimated from the survey, se the survey-based standard errors, and y the census counts.

Subscript i denotes a cell within a classification defined by variables such as age, sex, and time. For instance cell i might be 30-34 year old females in 2020.

Value

An object of class SpecLikelihoodNormalFixed.

See Also

NormalFixed is typically used as part of a call to function Model. More flexible normal models can be specified using Normal.

Examples

mean <- Values(array(c(0.95, 0.96, 0.95, 0.94),
                     dim = c(2, 2),
                     dimnames = list(age = c("0-39", "40+"),
                                     sex = c("Female", "Male"))))
sd <- Values(array(c(0.05, 0.08, 0.05, 0.04),
                   dim = c(2, 2),
                   dimnames = list(age = c("0-39", "40+"),
                                   sex = c("Female", "Male"))))
NormalFixed(mean = mean, sd = sd)
NormalFixed(mean = mean, sd = 0.1)
NormalFixed(mean = mean, sd = 0.1, useExpose = FALSE)

StatisticsNZ/demest documentation built on Nov. 2, 2023, 7:56 p.m.