mig_net_count_tot_b: Constructor for class 'mig_net_count_tot_b'

In markalava/ccmppWPP: Cohort Component Population Projection

Constructor for class mig_net_count_tot_b

Description

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

1. Value_type attribute equals “rate”.

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

Usage

mig_net_count_tot_b(x, ...)

## S3 method for class 'data.frame'
mig_net_count_tot_b(x, value_scale = attr(x, "value_scale"))

## S3 method for class 'mig_net_count_age_sex'
mig_net_count_tot_b(x)

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

mig_net_count_tot_b(x) <- value

Arguments

x	An object for which a method is defined (see “Details”).
...	Passed to the low-level constructor.
value_scale	Numeric scalar indicating the value_scale of the counts, e.g., 1, 1000, 1e6, etc.

Details

Methods are defined for data.frames and ccmpp_input_lists, mig_net_count_age_sex objects, 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.

The mig_net_count_age_sex method allows creation of total migration counts from age- sex-specific counts.

Value

An object of class mig_net_count_tot_b.

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_rate_age_sex(), mig_parameter(), mort_rate_age_sex(), pop_count_age_sex_base(), srb(), survival_ratio_age_sex()

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