new_mort_rate_age_sex: Low-level constructor for class 'mort_rate_age_sex'.

View source: R/S3_classes_ccmpp_input_mort_rate_df.R

new_mort_rate_age_sexR Documentation

Low-level constructor for class mort_rate_age_sex.

Description

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

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

Usage

new_mort_rate_age_sex(
  x,
  age_span = double(),
  time_span = double(),
  non_zero_fert_ages = double(),
  dimensions = get_req_dimensions_for_subclass_classes("mort_rate_age_sex"),
  value_type = get_value_types_for_subclass_classes("mort_rate_age_sex"),
  value_scale = NA,
  ...,
  class = character()
)

Arguments

dimensions

Character vector listing the dimensions such as “time”, “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.

Value

An object of class mort_rate_age_sex.

Author(s)

Mark Wheldon

See Also

mort_rate_age_sex


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