fert: Calculates fertility indicators based on survey data.

Description Usage Arguments Value Author(s) Examples

View source: R/fert.R

Description

fert returns fertility indicators such as the Total Fertility Rate (TFR), General Fertility Rate (GFR), and Age Specific Fertility Rate (ASFR) fert returns the Standard Error (SE), fertility exposure (N), weighted exposure (WN), Design Effect (DEFT), Relative Standard Error (RSE), and Confidence Interval (CI).

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
fert(
  Data.Name,
  Indicator,
  JK = NULL,
  CL = NULL,
  Strata = NULL,
  Cluster = NULL,
  Weight = NULL,
  Date_of_interview = NULL,
  Woman_DOB = NULL,
  EverMW = NULL,
  AWFact = NULL,
  PeriodEnd = NULL,
  Period = NULL,
  Class = NULL
)

Arguments

Data.Name

The DHS women (IR) dataset or data from other survey with the same format.

Indicator

Type of indicator to be calculated ("tfr", "gfr", "asfr").

JK

"Yes" to estimate Jackknife SE for TFR.

CL

Confidence level to calculate the Confidence Coefficient Z of the Confidence Intervals; default if 95.

Strata

Stratification variable if other than "v022".

Cluster

Sample cluster variable if other than "v021".

Weight

Survey weight variable if other than "v005".

Date_of_interview

Date of Interview (CMC) variable if other than "v008".

Woman_DOB

Woman date of birth (CMC) variable if other than "v011".

EverMW

"Yes" for ever-married women data.

AWFact

All-women factor variable in case of EverMW = “Yes”.

PeriodEnd

The end of the exposure period in YYYY-MM format; default is the date of the survey.

Period

The study period for fertility in months; default is 36 months (3 years).

Class

Allow for domain level indicators.

Value

Fertility indicators (TFR, GFR, or ASFR), and precision indicators (SE, DEFT, RSE, and CI).

Author(s)

Mahmoud Elkasabi.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Calculate TFR and estimate Jackknife SE based on all women AWIR70 data

data("AWIR70")
Total_Fertility_Rate <- fert(
 AWIR70,
 Indicator = "tfr",
 JK = "Yes"
)

# Calculate GFR and estimate SE based on ever-married women EMIR70 data

data("EMIR70")
General_Fertility_Rate <- fert(
 EMIR70,
 Indicator = "gfr",
 EverMW = "YES",
 AWFact = "awfactt"
)

# Calculate Urban/Rural level ASFR and estimate SE based on all women AWIR70 data

data("AWIR70")
Age_Specific_Fertility_Rate <- fert(
 AWIR70,
 Indicator = "asfr",
 Class = "v025"
)

DHS.rates documentation built on Dec. 11, 2021, 10:01 a.m.