new_pop_count_age_sex_reference: Low-level constructor for class...

View source: R/S3_classes_demog_change_component_pop_count_reference.R

new_pop_count_age_sex_referenceR Documentation

Low-level constructor for class pop_count_age_sex_reference.

Description

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

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

Usage

new_pop_count_age_sex_reference(
  x,
  dimensions = character(),
  time_span = 0,
  value_type = get_value_types_for_subclass_classes("pop_count_age_sex_reference"),
  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_reference.

Author(s)

Mark Wheldon

See Also

pop_count_age_sex_reference


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