fert_rate_tot_f: Calculate total fertility rates

View source: R/S3_classes_ccmpp_input_fert_rate_df.R

fert_rate_tot_fR Documentation

Calculate total fertility rates

Description

This generic function returns total fertility rates from an object with information on fertility.

Usage

fert_rate_tot_f(x, ...)

tfr(x, ...)

## S3 method for class 'fert_rate_age_f'
fert_rate_tot_f(x)

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

Arguments

x

An object with information on fertility; typically inheriting from fert_rate_age_f or ccmpp_input_list.

...

Passed to specific methods

Details

tfr is an alias for this function.

Value

An object of class demog_change_component_df

Author(s)

Mark Wheldon


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