mort_rate_age_sex: Constructor for class 'mort_rate_age_sex'

View source: R/S3_classes_ccmpp_input_mort_rate_df.R

mort_rate_age_sexR Documentation

Constructor for class mort_rate_age_sex

Description

mort_rate_age_sex is a subclass of ccmpp_input_df. It imposes two additional conditions:

  1. Value_type attribute equals “proportion”.

  2. Within year and sex, age must start at 0.

Usage

mort_rate_age_sex(x, ...)

## S3 method for class 'data.frame'
mort_rate_age_sex(x)

## S3 method for class 'life_table_age_sex'
mort_rate_age_sex(x)

## S3 method for class 'ccmpp_input_list'
mort_rate_age_sex(x)

mort_rate_age_sex(x) <- value

Arguments

x

An object for which a method is defined (see “Details”).

...

Passed to the low-level constructor.

Details

Methods are defined for data.frames and ccmpp_input_lists, and possibly other objects as well. The data.frame method “constructs” an object from x. The ccmpp_input_list method “extracts” an object from x. There is also a replacement function which complements the extraction methods.

Value

An object of class mort_rate_age_sex.

Author(s)

Mark Wheldon

See Also

validate_ccmppWPP_object for object validation, ccmpp_input_df for the class from which this one inherits.

Other ccmpp_input_objects: ccmpp_input_df(), ccmpp_input_list(), coerce_pop_count_age_sex_reference, death_count_age_sex(), death_probability_age_sex(), fert_rate_age_f(), life_table_age_sex(), mig_net_count_age_sex(), mig_net_count_tot_b(), mig_net_rate_age_sex(), mig_parameter(), pop_count_age_sex_base(), srb(), survival_ratio_age_sex()


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