extend_account: Extend an existing demographic account

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

Description

Add new periods to an existing demographic account, based on new data. The number of additional periods is inferred from the rates argument.

Usage

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

Arguments

account	A data frame holding a demographic account, typically created by a call to estimate_account or extend account.
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.

Value

A data frame holding a demographic account.

See Also

estimate_account, forecast_account

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