GetRatesC {VirtualPop}

Retrieves Cohort Data from the HMD and HFD and Obtains Cohort Rates

Description

Retrieves cohort data from the HMD and HFD and produces cohort rates (death rates by age and sex and conditional fertility rates by age and parity). The function combines the steps of (a) data retrieval and (b) extraction of mortality and fertility rates.

Usage

GetRatesC(country, user, pw_HMD, pw_HFD, refcohort)

Arguments

country

Code of the country selected. The code must be one of the country codes of HMD and HFD.

user

Name of the user, used at registration with the HMD and HFD. It is assumed that the same name is used for both HMD and HFD.

pw_HMD

Password to access HMD, provided at registration.

pw_HFD

Password to access HFD, provided at registration

refcohort

Year of birth of cohort for which the data are used for the simulation.

Value

A list object with three elements:

ASDR

Age-specific death rates by sex for selected birth cohort

ASFR

Age-specific fertility rates by parity for selected birth cohort

ratesM

Matrix of transition rates in format required for mulitstate modelling

The object returned by the function has five attributes:

country

Country

type

Type of data (period data or cohort data)

cohort

Birth cohort (year of birth

refyear

Calendar year for which period death rates are used to complete cohort experience in case of incomplete mortality experience (reference year).

start_pASDR

Lowest age for which cohort data are missing. The mortality rates of that age and higher ages are borrowed from period data collected in the reference year.

Examples

## Not run: 
ratesC  <- GetRatesC(country="USA",user,pw_HMD,pw_HFD,refcohort)

## End(Not run)