create_optional_settings: Validate or generate the optional settings used in the...

In ihmeuw-demographics/popMethods: Methods for Population Estimation

Description

Adds general settings for the interval size 'int', each year for which projected population estimates will exist 'years_projections', and the years in which census data exists 'census_years.

Also adds/validates settings related to specifying the B-spline linear basis functions. For all the year-specific input components (all except for 'baseline'), adds the 'k_years_input_name' setting which defines the start of each calendar year interval that will be knots in the B-spline linear basis functions. For all the age-specific input components (all except for 'srb'), adds the 'k_ages_input_name' setting which defines the start of each age-group interval that will be knots in the B-spline linear basis functions.

Usage

create_optional_settings(settings, inputs, data = NULL)

Arguments

settings	[list()] Named list of settings for running the popReconstruct model with. The required settings are the same as those required for demCore::ccmpp(), see Section: Settings for these. The optional settings specific to popReconstruct are described in Section: Optional popReconstruct Settings
inputs	[list()] [data.table()] for each ccmpp input. Requires 'srb', 'asfr', 'baseline'; mortality estimates provided as just 'survival' or two of 'mx', 'ax', and 'qx'; and migration estimates provided as just 'net_migration' or both 'immigration' and 'emigration'. See Section: Inputs for more information on each of the required inputs.
data	[list()] [data.table()] for each type of data input for the model (currently only 'population'). See Section: Data for more information.

Value

Invisibly returns reference to modified settings.

ihmeuw-demographics/popMethods documentation built on Jan. 29, 2021, 12:39 p.m.