estimate_account: Estimate a demographic account

In ONSdigital/Bayesian-demographic-accounts: Bayesian Demographic Accounts

Description

Estimate consistent counts of population, births, deaths, and migration. All counts are estimated from scratch.

Usage

estimate_account(
  rates,
  data_models,
  dominant = "Female",
  n_particle = 1000,
  n_thin = 1,
  threshold = 0.5,
  n_thread = NULL
)

Arguments

rates	A named list of data frames giving rates for births, deaths, and migration, as described in rates-arg.
data_models	A list of data models. Within each series, the models should be ordered according to reliability of the data, with most reliable coming first.
dominant	Which sex/gender is used in the denominantor when calculating fertility rates. Defaults to "Female".
n_particle	The number of particles to create. Defaults to 1000.
n_thin	Outputs contain n_particle/n_thin particles. Defaults to 1, so that all particles are returned.
threshold	Threshold for triggering resampling. A number between 0 and 1. Defaults to 0.5.
n_thread	Number of threads to be used in parallel processing. Currently ignored.

Details

If rates and data_models have "region", columns, the order of the regions is taken from the deaths dataset in rates.

Value

A data frame holding a demographic account.

See Also

extend_account, forecast_account

ONSdigital/Bayesian-demographic-accounts documentation built on Jan. 10, 2022, 12:34 a.m.