new_pop_count_age_sex: Low-level constructor for class 'pop_count_age_sex'.

In markalava/ccmppWPP: Cohort Component Population Projection

Low-level constructor for class pop_count_age_sex.

Description

Creates an object of class pop_count_age_sex. Minimal checks are done; for interactive use see pop_count_age_sex.

This function is not exported. The user-level constructor is pop_count_age_sex.

Usage

new_pop_count_age_sex(
  x,
  age_span = double(),
  time_span = 0,
  dimensions = get_req_dimensions_for_subclass_classes("pop_count_age_sex"),
  value_type = get_value_types_for_subclass_classes("pop_count_age_sex"),
  value_scale = double(),
  ...,
  class = character()
)

Arguments

x	For demog_change_component_df: A data frame with columns “age_start”, “age_span”, “sex”, “time_start”, “time_span”, and “value”.
value_type	Scalar indicating the type of the “value” column (e.g., “count”, “rate”, etc.).
value_scale	Numeric scalar indicating the value_scale of the counts, e.g., 1, 1000, 1e6, etc.
...	Passed to the low-level constructor.

Value

An object of class pop_count_age_sex.

Note

There is no age_span argument. Population counts have time span 0.

Author(s)

Mark Wheldon

See Also

pop_count_age_sex

markalava/ccmppWPP documentation built on April 21, 2022, 12:36 a.m.