create_detailed_settings: Helper function to create a detailed list of settings...
In ihmeuw-demographics/popMethods: Methods for Population Estimation

Description Usage Arguments Value Detailed settings

View source: R/popReconstruct_settings.R

Helper function to create a detailed list of settings specific to popReconstruct ccmpp inputs and outputs.

1	create_detailed_settings(settings)

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

[list()] of detailed settings for each ccmpp input and 'population'.

measure_type: whether the component is either stock (measured at a specific point in time) or flow (measured over a period of time). This determines if the component will have a 'year' or 'year_start' and 'year_end' columns.
id_cols: the id columns defining the input and output [data.table()].
years: the 'year_start' or 'year' values the input/output will have.
years_knots: the start of each calendar year interval that will be knots in the B-spline linear basis functions.
B_t: the B-spline basis matrix for a linear spline with knots specified at 'years_knots'.
sexes: the 'sex' values the input/output will have.
ages: the 'age_start' values the input/output will have.
age_knots: the start of each age group interval that will be knots in the B-spline linear basis functions.
B_a: the B-spline basis matrix for a linear spline with knots specified at 'ages_knots'.
transformation_name: character name of the transformation.
transformation: the transformation used when modeling each component.
inverse_transformation: the inverse transformation used when modeling each component.
transformation_arguments: additional arguments to pass to the 'transformation' and 'inverse_transformation' functions.
fixed: whether the ccmpp input component is to be estimated or fixed in the model.