new_pop_count_age_sex_base: Low-level constructor for class 'pop_count_age_sex_base'.

View source: R/S3_classes_ccmpp_input_pop_count_base_df.R

new_pop_count_age_sex_baseR Documentation

Low-level constructor for class pop_count_age_sex_base.

Description

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

Usage

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

Arguments

age_span

Scalar indicating the span of the age groups.

dimensions

Character vector listing the dimensions such as “age”, “sex”.

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.

Details

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

Value

An object of class pop_count_age_sex_base.

Note

There is no age_span argument. Baseline population counts have time span 0.

Author(s)

Mark Wheldon

See Also

pop_count_age_sex_base


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