new_fert_rate_age_f: Low-level constructor for class 'fert_rate_age_f'.

View source: R/S3_classes_ccmpp_input_fert_rate_df.R

new_fert_rate_age_fR Documentation

Low-level constructor for class fert_rate_age_f.

Description

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

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

Usage

new_fert_rate_age_f(
  x,
  age_span = double(),
  time_span = double(),
  dimensions = get_req_dimensions_for_subclass_classes("fert_rate_age_f"),
  value_type = get_value_types_for_subclass_classes("fert_rate_age_f"),
  value_scale = double(),
  non_zero_fert_ages = 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 fert_rate_age_f.

Author(s)

Mark Wheldon

See Also

fert_rate_age_f


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