dp.inputs.tfr: Spectrum demographic inputs

View source: R/extract-dp.R

dp.inputs.tfrR Documentation

Spectrum demographic inputs

Description

Spectrum demographic inputs

Usage

dp.inputs.tfr(dp.raw, direction = "wide", first.year = NULL, final.year = NULL)

dp.inputs.pasfr(
  dp.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

dp.inputs.migr.rate(
  dp.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

dp.inputs.migr.dist(
  dp.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

dp.inputs.srb(dp.raw, direction = "wide", first.year = NULL, final.year = NULL)

dp.inputs.surv(
  dp.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

dp.inputs.e0(dp.raw, direction = "wide", first.year = NULL, final.year = NULL)

Arguments

dp.raw

DemProj module data in raw format, as returned by read.raw.dp()

direction

Request "wide" (default) or "long" format data.

first.year

First year of the projection. If first.year=NULL, it will be filled in using dp.inputs.first.year()

final.year

Final year of the projection. If final.year=NULL, it will be filled in using dp.inputs.final.year()

Value

A data frame.

Functions

  • dp.inputs.tfr(): Total fertility rate by year.

  • dp.inputs.pasfr(): Proportionate age-specific fertility rates, specified as percentages (0 <= x <= 100).

  • dp.inputs.migr.rate(): Net numbers of migrants by sex and year.

  • dp.inputs.migr.dist(): Age distribution of net migrants by sex and year, normalized to sum to 100. Negative values indicate net flows of migrants that are in the opposite direction of overall net migration.

  • dp.inputs.srb(): Sex ratio at birth, expressed as the number of male births per 100 female births.

  • dp.inputs.surv(): Survival rates (Sx) by age, sex, and year. This is expressed as the proportion of people alive and age x at the start of the year who are still alive at the end of that year.

  • dp.inputs.e0(): Input life expectancy at birth (e0) by year and sex.


rlglaubius/SpectrumUtils documentation built on Jan. 3, 2025, 5:30 p.m.