Package {surveyPrev}

AH_TOBC_W_OTH

Description

AH_TOBC_W_OTH

Usage

AH_TOBC_W_OTH(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "AH_TOBC_W_OTH", year = 2018)

## End(Not run)

AH_TOBU_M_ASM

Description

AH_TOBU_M_ASM

Usage

AH_TOBU_M_ASM(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "AH_TOBU_M_ASM", year = 2018)

## End(Not run)

AH_TOBU_M_SNN

Description

AH_TOBU_M_SNN

Usage

AH_TOBU_M_SNN(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "AH_TOBU_M_SNN", year = 2018)

## End(Not run)

AH_TOBU_W_SNM

Description

AH_TOBU_W_SNM

Usage

AH_TOBU_W_SNM(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "AH_TOBU_W_SNM", year = 2018)

## End(Not run)

AH_TOBU_W_SNN

Description

AH_TOBU_W_SNN

Usage

AH_TOBU_W_SNN(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "AH_TOBU_W_SNN", year = 2018)

## End(Not run)

AN_ANEM_W_ANY IRdata Percentage of women aged 15-49 classified as having any anemia

Description

AN_ANEM_W_ANY IRdata Percentage of women aged 15-49 classified as having any anemia

Usage

AN_ANEM_W_ANY(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "AN_ANEM_W_ANY",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::AN_ANEM_W_ANY)

## End(Not run)

AN_NUTS_W_OVW Women who are overweight according to BMI (25.0-29.9) nt_wm_ovwt in github IR

Description

AN_NUTS_W_OVW Women who are overweight according to BMI (25.0-29.9) nt_wm_ovwt in github IR

Usage

AN_NUTS_W_OVW(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "AN_NUTS_W_OVW", year = 2018)

## End(Not run)

AN_NUTS_W_THN IRdata Women who are thin according to BMI (<18.5)

Description

AN_NUTS_W_THN IRdata Women who are thin according to BMI (<18.5)

Usage

AN_NUTS_W_THN(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "AN_NUTS_W_THN",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::AN_NUTS_W_THN)

## End(Not run)

CH_ARIS_C_ADV Children with ARI for whom advice or treatment was sought; ch_ari_care in github KR

Description

CH_ARIS_C_ADV Children with ARI for whom advice or treatment was sought; ch_ari_care in github KR

Usage

CH_ARIS_C_ADV(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_ARIS_C_ADV", year = 2018)

## End(Not run)

CH_DIAT_C_ABI

Description

CH_DIAT_C_ABI

Usage

CH_DIAT_C_ABI(KRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_DIAT_C_ABI", year = 2018)

## End(Not run)

CH_DIAT_C_ADV Treatment of diarrhea: Advice or treatment was sought; ch_diar_care in github KR

Description

CH_DIAT_C_ADV Treatment of diarrhea: Advice or treatment was sought; ch_diar_care in github KR

Usage

CH_DIAT_C_ADV(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_DIAT_C_ADV", year = 2018)

## End(Not run)

CH_DIAT_C_AMO

Description

CH_DIAT_C_AMO

Usage

CH_DIAT_C_AMO(KRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_DIAT_C_AMO", year = 2018)

## End(Not run)

CH_DIAT_C_NOT

Description

CH_DIAT_C_NOT

Usage

CH_DIAT_C_NOT(KRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_DIAT_C_NOT", year = 2018)

## End(Not run)

CH_DIAT_C_ORS

Description

CH_DIAT_C_ORS

Usage

CH_DIAT_C_ORS(KRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_DIAT_C_ORS", year = 2018)

## End(Not run)

CH_DIAT_C_ORT

Description

CH_DIAT_C_ORT

Usage

CH_DIAT_C_ORT(KRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_DIAT_C_ORT", year = 2018)

## End(Not run)

CH_DIAT_C_OSI

Description

CH_DIAT_C_OSI

Usage

CH_DIAT_C_OSI(KRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_DIAT_C_OSI", year = 2018)

## End(Not run)

CH_DIAT_C_RHF

Description

CH_DIAT_C_RHF

Usage

CH_DIAT_C_RHF(KRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_DIAT_C_RHF", year = 2018)

## End(Not run)

CH_DIFP_C_FAL

Description

CH_DIFP_C_FAL

Usage

CH_DIFP_C_FAL(KRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_DIFP_C_FAL", year = 2018)

## End(Not run)

CH_FEVR_C_FEV

Description

CH_FEVR_C_FEV

Usage

CH_FEVR_C_FEV(KRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_FEVR_C_FEV", year = 2018)

## End(Not run)

CH_FEVT_C_ADV Children with fever for whom advice or treatment was sought ch_fev_care in github ml_fev_care should produce the same data KR

Description

CH_FEVT_C_ADV Children with fever for whom advice or treatment was sought ch_fev_care in github ml_fev_care should produce the same data KR

Usage

CH_FEVT_C_ADV(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_FEVT_C_ADV", year = 2018)

## End(Not run)

CH_SZWT_C_L25

Description

CH_SZWT_C_L25

Usage

CH_SZWT_C_L25(KRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_SZWT_C_L25", year = 2018)

## End(Not run)

CH_VACC_C_BAS KRdata Children with all 8 basic vaccinations (age 12-23)

Description

CH_VACC_C_BAS KRdata Children with all 8 basic vaccinations (age 12-23)

Usage

CH_VACC_C_BAS(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "CH_VACC_C_BAS",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::CH_VACC_C_BAS)

## End(Not run)

CH_VACC_C_BCG Percentage of children 12-23 months who had received BCG vaccination ms_afm_15 in github KR

Description

CH_VACC_C_BCG Percentage of children 12-23 months who had received BCG vaccination ms_afm_15 in github KR

Usage

CH_VACC_C_BCG(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CH_VACC_C_BCG", year = 2018)

## End(Not run)

CH_VACC_C_DP1 KRdata Pentavalent 1st dose vaccination Percentage of children (age 12-23) with 1st dose of Pentavalent vaccine

Description

CH_VACC_C_DP1 KRdata Pentavalent 1st dose vaccination Percentage of children (age 12-23) with 1st dose of Pentavalent vaccine

Usage

CH_VACC_C_DP1(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "CH_VACC_C_DP1",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::CH_VACC_C_DP1)

## End(Not run)

CH_VACC_C_DP3 KRdata Pentavalent 3rd dose vaccination Percentage of children (age 12-23) with 3rd dose of Pentavalent vaccine

Description

CH_VACC_C_DP3 KRdata Pentavalent 3rd dose vaccination Percentage of children (age 12-23) with 3rd dose of Pentavalent vaccine

Usage

CH_VACC_C_DP3(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "CH_VACC_C_DP3",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::CH_VACC_C_DP3)

## End(Not run)

CH_VACC_C_MSL KRdata Measles vaccination received Percentage of children (age 12-23)

Description

CH_VACC_C_MSL KRdata Measles vaccination received Percentage of children (age 12-23)

Usage

CH_VACC_C_MSL(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "CH_VACC_C_MSL",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::CH_VACC_C_MSL)

## End(Not run)

CH_VACC_C_NON KRdata Children with no vaccinations (age 12-23)

Description

CH_VACC_C_NON KRdata Children with no vaccinations (age 12-23)

Usage

CH_VACC_C_NON(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "CH_VACC_C_NON",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::CH_VACC_C_NON)

## End(Not run)

CH_VACC_C_PN3 KRdata Pneumococcal 3rd dose vaccination Percentage of children (age 12-23)

Description

CH_VACC_C_PN3 KRdata Pneumococcal 3rd dose vaccination Percentage of children (age 12-23)

Usage

CH_VACC_C_PN3(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "CH_VACC_C_PN3",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::CH_VACC_C_PN3)

## End(Not run)

CH_VACC_C_RT1 KRdata Rotavirus 1 vaccination received

Description

CH_VACC_C_RT1 KRdata Rotavirus 1 vaccination received

Usage

CH_VACC_C_RT1(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "CH_VACC_C_RT1",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::CH_VACC_C_RT1)

## End(Not run)

CH_VACS_C_PN3 KRdata Pneumococcal 3 vaccination received

Description

CH_VACS_C_PN3 KRdata Pneumococcal 3 vaccination received

Usage

CH_VACS_C_PN3(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "CH_VACS_C_PN3",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::CH_VACS_C_PN3)

## End(Not run)

CM_ECMR_C_IMF imr 5 years prior to survey.

Description

BR

Usage

CM_ECMR_C_IMF(Rdata, mort.cut = c(1, 2, 6, 12, 24, 36, 48, 60), mort.year = 5)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CM_ECMR_C_IMF", year = 2018)

## End(Not run)

CM_ECMR_C_IMR imr 10 years prior to survey.

Description

BR

Usage

CM_ECMR_C_IMR(Rdata, mort.cut = c(1, 2, 6, 12, 24, 36, 48, 60), mort.year = 10)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CM_ECMR_C_IMR", year = 2018)

## End(Not run)

CM_ECMR_C_NNF NMR five years prior to survey.

Description

BR

Usage

CM_ECMR_C_NNF(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CM_ECMR_C_NNF", year = 2018)

## End(Not run)

CM_ECMR_C_NNR BRdata Neonatal mortality rate

Description

CM_ECMR_C_NNR BRdata Neonatal mortality rate

Usage

CM_ECMR_C_NNR(Rdata, nmr.year = 10)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "CM_ECMR_C_NNR",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::CM_ECMR_C_NNR)

## End(Not run)

CM_ECMR_C_U5F u5mr 5 years prior to survey.

Description

BR

Usage

CM_ECMR_C_U5F(Rdata, mort.cut = c(1, 2, 6, 12, 24, 36, 48, 60), mort.year = 5)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CM_ECMR_C_U5F", year = 2018)

## End(Not run)

CM_ECMR_C_U5M u5mr 10 years prior to survey.

Description

BR

Usage

CM_ECMR_C_U5M(Rdata, mort.cut = c(1, 2, 6, 12, 24, 36, 48, 60), mort.year = 10)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CM_ECMR_C_U5M", year = 2018)

## End(Not run)

CN_ANMC_C_ANY PRdata Children with any anemia Children under five with any anemia

Description

CN_ANMC_C_ANY PRdata Children with any anemia Children under five with any anemia

Usage

CN_ANMC_C_ANY(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "CN_ANMC_C_ANY",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::CN_ANMC_C_ANY)

## End(Not run)

CN_BRFI_C_EVR

Description

CN_BRFI_C_EVR

Usage

CN_BRFI_C_EVR(KRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CN_BRFI_C_EVR", year = 2018)

## End(Not run)

CN_BRFS_C_EXB KRdata Children exclusively breastfed Prevalence of exclusive breastfeeding of children under six months of age

Description

CN_BRFS_C_EXB KRdata Children exclusively breastfed Prevalence of exclusive breastfeeding of children under six months of age

Usage

CN_BRFS_C_EXB(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "CN_BRFS_C_EXB",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::CN_BRFS_C_EXB)

## End(Not run)

CN_IYCF_C_4FA Percentage of children age 6-23 months fed five or more food groups. The food groups are a. breastmilk b. infant formula, milk other than breast milk, cheese or yogurt or other milk products; c. foods made from grains, roots, and tubers, including porridge and fortified baby food from grains; d. vitamin A-rich fruits and vegetables (and red palm oil); e. other fruits and vegetables; f. eggs; g. meat, poultry, fish, and shellfish (and organ meats); h. legumes and nuts. nt_mdd in github KR

Description

CN_IYCF_C_4FA Percentage of children age 6-23 months fed five or more food groups. The food groups are a. breastmilk b. infant formula, milk other than breast milk, cheese or yogurt or other milk products; c. foods made from grains, roots, and tubers, including porridge and fortified baby food from grains; d. vitamin A-rich fruits and vegetables (and red palm oil); e. other fruits and vegetables; f. eggs; g. meat, poultry, fish, and shellfish (and organ meats); h. legumes and nuts. nt_mdd in github KR

Usage

CN_IYCF_C_4FA(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CN_IYCF_C_4FA", year = 2018)

## End(Not run)

CN_NUTS_C_HA2

Description

CN_NUTS_C_HA2

Usage

CN_NUTS_C_HA2(PRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CN_NUTS_C_HA2", year = 2018)

## End(Not run)

CN_NUTS_C_HA3

Description

CN_NUTS_C_HA3

Usage

CN_NUTS_C_HA3(PRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CN_NUTS_C_HA3", year = 2018)

## End(Not run)

CN_NUTS_C_WA2

Description

CN_NUTS_C_WA2

Usage

CN_NUTS_C_WA2(PRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CN_NUTS_C_WA2", year = 2018)

## End(Not run)

CN_NUTS_C_WA3

Description

CN_NUTS_C_WA3

Usage

CN_NUTS_C_WA3(PRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CN_NUTS_C_WA3", year = 2018)

## End(Not run)

CN_NUTS_C_WAP

Description

CN_NUTS_C_WAP

Usage

CN_NUTS_C_WAP(PRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CN_NUTS_C_WAP", year = 2018)

## End(Not run)

CN_NUTS_C_WH2

Description

CN_NUTS_C_WH2

Usage

CN_NUTS_C_WH2(PRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CN_NUTS_C_WH2", year = 2018)

## End(Not run)

CN_NUTS_C_WH3

Description

CN_NUTS_C_WH3

Usage

CN_NUTS_C_WH3(PRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CN_NUTS_C_WH3", year = 2018)

## End(Not run)

CN_NUTS_C_WHP

Description

CN_NUTS_C_WHP

Usage

CN_NUTS_C_WHP(PRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CN_NUTS_C_WHP", year = 2018)

## End(Not run)

CO_INUS_W_EVU

Description

CO_INUS_W_EVU

Usage

CO_INUS_W_EVU(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CO_INUS_W_EVU", year = 2018)

## End(Not run)

CO_INUS_W_U12

Description

CO_INUS_W_U12

Usage

CO_INUS_W_U12(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CO_INUS_W_U12", year = 2018)

## End(Not run)

CO_MOBB_W_BNK

Description

CO_MOBB_W_BNK

Usage

CO_MOBB_W_BNK(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CO_MOBB_W_BNK", year = 2018)

## End(Not run)

CO_MOBB_W_MBF

Description

CO_MOBB_W_MBF

Usage

CO_MOBB_W_MBF(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CO_MOBB_W_MBF", year = 2018)

## End(Not run)

CO_MOBB_W_MOB

Description

CO_MOBB_W_MOB

Usage

CO_MOBB_W_MOB(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CO_MOBB_W_MOB", year = 2018)

## End(Not run)

CP_BREG_C_CRT

Description

CP_BREG_C_CRT

Usage

CP_BREG_C_CRT(PRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CP_BREG_C_CRT", year = 2018)

## End(Not run)

CP_BREG_C_NCT

Description

CP_BREG_C_NCT

Usage

CP_BREG_C_NCT(PRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CP_BREG_C_NCT", year = 2018)

## End(Not run)

CP_BREG_C_REG

Description

CP_BREG_C_REG

Usage

CP_BREG_C_REG(PRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "CP_BREG_C_REG", year = 2018)

## End(Not run)

DV_AFSV_W_A10

Description

DV_AFSV_W_A10

Usage

DV_AFSV_W_A10(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "DV_AFSV_W_A10", year = 2018)

## End(Not run)

DV_AFSV_W_A12

Description

DV_AFSV_W_A12

Usage

DV_AFSV_W_A12(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "DV_AFSV_W_A12", year = 2018)

## End(Not run)

DV_EXPV_W_12M Percentage of women who have experienced physical violence in the past 12 months often or sometimes dv_phy_12m in github IR

Description

DV_EXPV_W_12M Percentage of women who have experienced physical violence in the past 12 months often or sometimes dv_phy_12m in github IR

Usage

DV_EXPV_W_12M(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "DV_EXPV_W_12M", year = 2018)

## End(Not run)

DV_EXSV_W_12M Percentage of women who ever experienced sexual violence dv_sex_12m in github IR

Description

DV_EXSV_W_12M Percentage of women who ever experienced sexual violence dv_sex_12m in github IR

Usage

DV_EXSV_W_12M(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "DV_EXSV_W_12M", year = 2018)

## End(Not run)

DV_EXSV_W_EVR Percentage of women who ever experienced sexual violence dv_sex in github IR

Description

DV_EXSV_W_EVR Percentage of women who ever experienced sexual violence dv_sex in github IR

Usage

DV_EXSV_W_EVR(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "DV_EXSV_W_EVR", year = 2018)

## End(Not run)

DV_PCPV_W_CBF

Description

DV_PCPV_W_CBF

Usage

DV_PCPV_W_CBF(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "DV_PCPV_W_CBF", year = 2018)

## End(Not run)

DV_PCPV_W_CHD

Description

DV_PCPV_W_CHD

Usage

DV_PCPV_W_CHD(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "DV_PCPV_W_CHD", year = 2018)

## End(Not run)

DV_PCPV_W_EMP

Description

DV_PCPV_W_EMP

Usage

DV_PCPV_W_EMP(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "DV_PCPV_W_EMP", year = 2018)

## End(Not run)

DV_PCPV_W_FLW

Description

DV_PCPV_W_FLW

Usage

DV_PCPV_W_FLW(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "DV_PCPV_W_FLW", year = 2018)

## End(Not run)

DV_PCPV_W_OLW

Description

DV_PCPV_W_OLW

Usage

DV_PCPV_W_OLW(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "DV_PCPV_W_OLW", year = 2018)

## End(Not run)

DV_STPS_W_BFR

Description

DV_STPS_W_BFR

Usage

DV_STPS_W_BFR(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "DV_STPS_W_BFR", year = 2018)

## End(Not run)

DV_VPRG_W_VPG

Description

DV_VPRG_W_VPG

Usage

DV_VPRG_W_VPG(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "DV_VPRG_W_VPG", year = 2018)

## End(Not run)

ED_EDUC_W_SEH IRdata Percentage of women with secondary or higher education

Description

ED_EDUC_W_SEH IRdata Percentage of women with secondary or higher education

Usage

ED_EDUC_W_SEH(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_CUSA_W_MOD",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::fp_cruse_mod)

## End(Not run)

ED_LITR_W_LIT

Description

ED_LITR_W_LIT

Usage

ED_LITR_W_LIT(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "ED_LITR_W_LIT", year = 2018)

## End(Not run)

ED_MDIA_W_3MD

Description

ED_MDIA_W_3MD

Usage

ED_MDIA_W_3MD(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "ED_MDIA_W_3MD", year = 2018)

## End(Not run)

ED_MDIA_W_N3M

Description

ED_MDIA_W_N3M

Usage

ED_MDIA_W_N3M(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "ED_MDIA_W_N3M", year = 2018)

## End(Not run)

ED_MDIA_W_NWS

Description

ED_MDIA_W_NWS

Usage

ED_MDIA_W_NWS(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "ED_MDIA_W_NWS", year = 2018)

## End(Not run)

ED_MDIA_W_RDO

Description

ED_MDIA_W_RDO

Usage

ED_MDIA_W_RDO(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "ED_MDIA_W_RDO", year = 2018)

## End(Not run)

ED_MDIA_W_TLV

Description

ED_MDIA_W_TLV

Usage

ED_MDIA_W_TLV(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "ED_MDIA_W_TLV", year = 2018)

## End(Not run)

EM_EMPM_W_EMP

Description

EM_EMPM_W_EMP

Usage

EM_EMPM_W_EMP(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "EM_EMPM_W_EMP", year = 2018)

## End(Not run)

FG_KFCC_W_HFC IRdata Percentage of women who have ever heard of female circumcision

Description

FG_KFCC_W_HFC IRdata Percentage of women who have ever heard of female circumcision

Usage

FG_KFCC_W_HFC(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_CUSA_W_MOD",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::fp_cruse_mod)

## End(Not run)

FG_PFCC_W_WCC IRdata Percentage of women circumcised (women who experienced female genital cutting (FGM))

Description

FG_PFCC_W_WCC IRdata Percentage of women circumcised (women who experienced female genital cutting (FGM))

Usage

FG_PFCC_W_WCC(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_CUSA_W_MOD",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::fp_cruse_mod)

## End(Not run)

FP_CUSA_W_ANY

Description

FP_CUSA_W_ANY

Usage

FP_CUSA_W_ANY(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_CUSA_W_ANY", year = 2018)

## End(Not run)

FP_CUSA_W_EMC

Description

FP_CUSA_W_EMC

Usage

FP_CUSA_W_EMC(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_CUSA_W_EMC", year = 2018)

## End(Not run)

FP_CUSA_W_FCN

Description

FP_CUSA_W_FCN

Usage

FP_CUSA_W_FCN(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_CUSA_W_FCN", year = 2018)

## End(Not run)

FP_CUSA_W_FST

Description

FP_CUSA_W_FST

Usage

FP_CUSA_W_FST(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_CUSA_W_FST", year = 2018)

## End(Not run)

FP_CUSA_W_IMP

Description

FP_CUSA_W_IMP

Usage

FP_CUSA_W_IMP(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_CUSA_W_IMP", year = 2018)

## End(Not run)

FP_CUSA_W_INJ

Description

FP_CUSA_W_INJ

Usage

FP_CUSA_W_INJ(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_CUSA_W_INJ", year = 2018)

## End(Not run)

FP_CUSA_W_IUD

Description

FP_CUSA_W_IUD

Usage

FP_CUSA_W_IUD(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_CUSA_W_IUD", year = 2018)

## End(Not run)

FP_CUSA_W_MCN

Description

FP_CUSA_W_MCN

Usage

FP_CUSA_W_MCN(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_CUSA_W_MCN", year = 2018)

## End(Not run)

FP_CUSA_W_MOD IRdata Modern contraceptive prevalence rate (women currently using any modern method of contraception)

Description

FP_CUSA_W_MOD IRdata Modern contraceptive prevalence rate (women currently using any modern method of contraception)

Usage

FP_CUSA_W_MOD(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_CUSA_W_MOD",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::FP_CUSA_W_MOD)

## End(Not run)

FP_CUSA_W_MST

Description

FP_CUSA_W_MST

Usage

FP_CUSA_W_MST(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_CUSA_W_MST", year = 2018)

## End(Not run)

FP_CUSA_W_PIL

Description

FP_CUSA_W_PIL

Usage

FP_CUSA_W_PIL(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_CUSA_W_PIL", year = 2018)

## End(Not run)

FP_CUSA_W_STD

Description

FP_CUSA_W_STD

Usage

FP_CUSA_W_STD(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_CUSA_W_STD", year = 2018)

## End(Not run)

FP_CUSA_W_TRA

Description

FP_CUSA_W_TRA

Usage

FP_CUSA_W_TRA(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_CUSA_W_TRA", year = 2018)

## End(Not run)

FP_CUSA_W_WTH

Description

FP_CUSA_W_WTH

Usage

FP_CUSA_W_WTH(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_CUSA_W_WTH", year = 2018)

## End(Not run)

FP_CUSM_W_MOD IRdata Modern contraceptive prevalence rate (Married women currently using any modern method of contraception)

Description

FP_CUSM_W_MOD IRdata Modern contraceptive prevalence rate (Married women currently using any modern method of contraception)

Usage

FP_CUSM_W_MOD(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_CUSA_W_MOD",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::FP_CUSM_W_MOD)

## End(Not run)

FP_EFPM_M_NWS

Description

FP_EFPM_M_NWS

Usage

FP_EFPM_M_NWS(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_EFPM_M_NWS", year = 2018)

## End(Not run)

FP_EFPM_M_TLV

Description

FP_EFPM_M_TLV

Usage

FP_EFPM_M_TLV(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_EFPM_M_TLV", year = 2018)

## End(Not run)

FP_EFPM_W_NWS

Description

FP_EFPM_W_NWS

Usage

FP_EFPM_W_NWS(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_EFPM_W_NWS", year = 2018)

## End(Not run)

FP_EFPM_W_RDO

Description

FP_EFPM_W_RDO

Usage

FP_EFPM_W_RDO(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_EFPM_W_RDO", year = 2018)

## End(Not run)

FP_EFPM_W_TLV

Description

FP_EFPM_W_TLV

Usage

FP_EFPM_W_TLV(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_EFPM_W_TLV", year = 2018)

## End(Not run)

FP_EVUM_W_MOD

Description

FP_EVUM_W_MOD

Usage

FP_EVUM_W_MOD(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_EVUM_W_MOD", year = 2018)

## End(Not run)

FP_KMTA_W_ANY

Description

FP_KMTA_W_ANY

Usage

FP_KMTA_W_ANY(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_KMTA_W_ANY", year = 2018)

## End(Not run)

FP_KMTA_W_EMC

Description

FP_KMTA_W_EMC

Usage

FP_KMTA_W_EMC(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_KMTA_W_EMC", year = 2018)

## End(Not run)

FP_KMTA_W_FCN

Description

FP_KMTA_W_FCN

Usage

FP_KMTA_W_FCN(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_KMTA_W_FCN", year = 2018)

## End(Not run)

FP_KMTA_W_FST

Description

FP_KMTA_W_FST

Usage

FP_KMTA_W_FST(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_KMTA_W_FST", year = 2018)

## End(Not run)

FP_KMTA_W_IMP

Description

FP_KMTA_W_IMP

Usage

FP_KMTA_W_IMP(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_KMTA_W_IMP", year = 2018)

## End(Not run)

FP_KMTA_W_INJ

Description

FP_KMTA_W_INJ

Usage

FP_KMTA_W_INJ(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_KMTA_W_INJ", year = 2018)

## End(Not run)

FP_KMTA_W_IUD

Description

FP_KMTA_W_IUD

Usage

FP_KMTA_W_IUD(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_KMTA_W_IUD", year = 2018)

## End(Not run)

FP_KMTA_W_MST

Description

FP_KMTA_W_MST

Usage

FP_KMTA_W_MST(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_KMTA_W_MST", year = 2018)

## End(Not run)

FP_KMTA_W_OMD

Description

FP_KMTA_W_OMD

Usage

FP_KMTA_W_OMD(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_KMTA_W_OMD", year = 2018)

## End(Not run)

FP_KMTA_W_PIL

Description

FP_KMTA_W_PIL

Usage

FP_KMTA_W_PIL(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_KMTA_W_PIL", year = 2018)

## End(Not run)

FP_KMTA_W_STD

Description

FP_KMTA_W_STD

Usage

FP_KMTA_W_STD(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_KMTA_W_STD", year = 2018)

## End(Not run)

FP_KMTA_W_TRA

Description

FP_KMTA_W_TRA

Usage

FP_KMTA_W_TRA(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_KMTA_W_TRA", year = 2018)

## End(Not run)

FP_KMTA_W_WTH

Description

FP_KMTA_W_WTH

Usage

FP_KMTA_W_WTH(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_KMTA_W_WTH", year = 2018)

## End(Not run)

FP_NADA_W_UNT IRdata Women with an unmet need for family planning for spacing and limiting

Description

FP_NADA_W_UNT IRdata Women with an unmet need for family planning for spacing and limiting

Usage

FP_NADA_W_UNT(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_NADA_W_UNT",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::FP_NADA_W_UNT)

## End(Not run)

FP_NADA_W_UNT IRdata Women with an unmet need for family planning for spacing and limiting

Description

FP_NADA_W_UNT IRdata Women with an unmet need for family planning for spacing and limiting

Usage

FP_NADM_W_PDM(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_NADM_W_PDM",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::FP_NADM_W_PDM)

## End(Not run)

FP_NADM_W_UNT #unmet_family IRdata Married women with an unmet need for family planning for spacing and limiting, line 17 manually added by Qianyu

Description

FP_NADM_W_UNT #unmet_family IRdata Married women with an unmet need for family planning for spacing and limiting, line 17 manually added by Qianyu

Usage

FP_NADM_W_UNT(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "FP_NADM_W_UNT", year = 2018)

## End(Not run)

FP_NADA_W_UNT IRdata Women with an unmet need for family planning for spacing and limiting

Description

FP_NADA_W_UNT IRdata Women with an unmet need for family planning for spacing and limiting

Usage

FP_NDYA_W_PDM(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_NDYA_W_PDM",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::FP_NDYA_W_PDM)

## End(Not run)

HA_AFSY_M_A15

Description

HA_AFSY_M_A15

Usage

HA_AFSY_M_A15(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_AFSY_M_A15", year = 2018)

## End(Not run)

HA_AFSY_M_A18

Description

HA_AFSY_M_A18

Usage

HA_AFSY_M_A18(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_AFSY_M_A18", year = 2018)

## End(Not run)

HA_AFSY_W_A18

Description

HA_AFSY_W_A18

Usage

HA_AFSY_W_A18(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_AFSY_W_A18", year = 2018)

## End(Not run)

HA_ANSS_M_CND

Description

HA_ANSS_M_CND

Usage

HA_ANSS_M_CND(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_ANSS_M_CND", year = 2018)

## End(Not run)

HA_ANSS_W_CND

Description

HA_ANSS_W_CND

Usage

HA_ANSS_W_CND(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_ANSS_W_CND", year = 2018)

## End(Not run)

HA_ANSS_W_RSX

Description

HA_ANSS_W_RSX

Usage

HA_ANSS_W_RSX(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_ANSS_W_RSX", year = 2018)

## End(Not run)

HA_CATH_W_ATN

Description

HA_CATH_W_ATN

Usage

HA_CATH_W_ATN(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 

## Not run: 

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_CATH_W_ATN", year = 2018)

## End(Not run)

HA_CATH_W_NRS

Description

HA_CATH_W_NRS

Usage

HA_CATH_W_NRS(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 

## Not run: 

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_CATH_W_NRS", year = 2018)

## End(Not run)

HA_HIVP_B_HIV hv_hiv_pos "HIV prevalence among general population"

Description

HA_HIVP_B_HIV hv_hiv_pos "HIV prevalence among general population"

Usage

HA_HIVP_B_HIV(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "HA_HIVP_B_HIV",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::HA_HIVP_B_HIV)

## End(Not run)

HA_HRSX_W_CND

Description

HA_HRSX_W_CND

Usage

HA_HRSX_W_CND(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_HRSX_W_CND", year = 2018)

## End(Not run)

HA_HVST_M_HRD

Description

HA_HVST_M_HRD

Usage

HA_HVST_M_HRD(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_HVST_M_HRD", year = 2018)

## End(Not run)

HA_HVST_M_USD

Description

HA_HVST_M_USD

Usage

HA_HVST_M_USD(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_HVST_M_USD", year = 2018)

## End(Not run)

HA_HVTY_M_TRR

Description

HA_HVTY_M_TRR

Usage

HA_HVTY_M_TRR(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_HVTY_M_TRR", year = 2018)

## End(Not run)

HA_HVTY_W_TRR

Description

HA_HVTY_W_TRR

Usage

HA_HVTY_W_TRR(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_HVTY_W_TRR", year = 2018)

## End(Not run)

HA_KAID_W_HRD Percentage of women who have heard of HIV or AIDS hk_ever_heard in github IR

Description

HA_KAID_W_HRD Percentage of women who have heard of HIV or AIDS hk_ever_heard in github IR

Usage

HA_KAID_W_HRD(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_KAID_W_HRD", year = 2018)

## End(Not run)

HA_STIS_M_DIS

Description

HA_STIS_M_DIS

Usage

HA_STIS_M_DIS(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_STIS_M_DIS", year = 2018)

## End(Not run)

HA_STIS_M_SOR

Description

HA_STIS_M_SOR

Usage

HA_STIS_M_SOR(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_STIS_M_SOR", year = 2018)

## End(Not run)

HA_STIS_W_STI Percentage of women reporting a sexually transmitted infection in the 12 months preceding the survey among women who ever had sexual intercourse hk_sti in github IR

Description

HA_STIS_W_STI Percentage of women reporting a sexually transmitted infection in the 12 months preceding the survey among women who ever had sexual intercourse hk_sti in github IR

Usage

HA_STIS_W_STI(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HA_STIS_W_STI", year = 2018)

## End(Not run)

HC_AGEG_P_ADL

Description

HC_AGEG_P_ADL

Usage

HC_AGEG_P_ADL(PRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HC_AGEG_P_ADL", year = 2018)

## End(Not run)

HC_ELEC_H_ELC Percentage of households with electricity ph_electric in github HR

Description

HC_ELEC_H_ELC Percentage of households with electricity ph_electric in github HR

Usage

HC_ELEC_H_ELC(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HC_ELEC_H_ELC", year = 2018)

## End(Not run)

HC_FLRM_H_CER Percentage of households with ceramic tile floors ph_floor in github HR

Description

HC_FLRM_H_CER Percentage of households with ceramic tile floors ph_floor in github HR

Usage

HC_FLRM_H_CER(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HC_FLRM_H_CER", year = 2018)

## End(Not run)

HC_HEFF_H_RDO Percentage of households possessing a radio ph_radio in github HR

Description

HC_HEFF_H_RDO Percentage of households possessing a radio ph_radio in github HR

Usage

HC_HEFF_H_RDO(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "HC_HEFF_H_RDO", year = 2018)

## End(Not run)

HC_WIXQ_P_12Q PRdata Population in the lowest and second wealth quintile

Description

HC_WIXQ_P_12Q PRdata Population in the lowest and second wealth quintile

Usage

HC_WIXQ_P_12Q(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_CUSA_W_MOD",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::fp_cruse_mod)

## End(Not run)

HC_WIXQ_P_2ND PRdata Population in the second wealth quintile

Description

HC_WIXQ_P_2ND PRdata Population in the second wealth quintile

Usage

HC_WIXQ_P_2ND(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_CUSA_W_MOD",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::fp_cruse_mod)

## End(Not run)

HC_WIXQ_P_LOW PRdata Population in the lowest wealth quintile

Description

HC_WIXQ_P_LOW PRdata Population in the lowest wealth quintile

Usage

HC_WIXQ_P_LOW(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_CUSA_W_MOD",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::fp_cruse_mod)

## End(Not run)

MA_CWIV_W_CWV

Description

MA_CWIV_W_CWV

Usage

MA_CWIV_W_CWV(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "MA_CWIV_W_CWV", year = 2018)

## End(Not run)

MA_MBAG_W_B15 Women first married by exact age 15 ms_afm_15 in github IR

Description

MA_MBAG_W_B15 Women first married by exact age 15 ms_afm_15 in github IR

Usage

MA_MBAG_W_B15(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "MA_MBAG_W_B15", year = 2018)

## End(Not run)

##' MA_MBAG_W_B18 Percentage of women first married by exact age 18 ms_afm_18 in github IR

Description

##' MA_MBAG_W_B18 Percentage of women first married by exact age 18 ms_afm_18 in github IR

Usage

MA_MBAG_W_B18(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "MA_MBAG_W_B18", year = 2018)

## End(Not run)

MA_MBAY_W_B15 Young women age 20-24 first married by exact age 15 ms_afm_15 in github IR

Description

MA_MBAY_W_B15 Young women age 20-24 first married by exact age 15 ms_afm_15 in github IR

Usage

MA_MBAY_W_B15(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "MA_MBAY_W_B15", year = 2018)

## End(Not run)

MA_MBAY_W_B18 Percentage of Young women age 20-24 first married by exact age 18 ms_afm_18 in github IR

Description

MA_MBAY_W_B18 Percentage of Young women age 20-24 first married by exact age 18 ms_afm_18 in github IR

Usage

MA_MBAY_W_B18(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "MA_MBAY_W_B18", year = 2018)

## End(Not run)

MA_MSTA_W_NMA

Description

MA_MSTA_W_NMA

Usage

MA_MSTA_W_NMA(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "MA_MSTA_W_NMA", year = 2018)

## End(Not run)

ML_NETC_C_ITN PRdata Percentage of children under age five who slept under an insecticide treated net (ITN) the night before the survey

Description

ML_NETC_C_ITN PRdata Percentage of children under age five who slept under an insecticide treated net (ITN) the night before the survey

Usage

ML_NETC_C_ITN(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_CUSA_W_MOD",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::fp_cruse_mod)

## End(Not run)

ML_NETP_H_IT2 HRdata Households with access to an insecticide-treated mosquito net (ITN)

Description

ML_NETP_H_IT2 HRdata Households with access to an insecticide-treated mosquito net (ITN)

Usage

ML_NETP_H_IT2(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "ML_NETP_H_IT2",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::ML_NETP_H_IT2)

## End(Not run)

ML_NETU_P_ITN PRdata Percentage of the de facto household population who slept under an insecticide treated net the night before the survey

Description

ML_NETU_P_ITN PRdata Percentage of the de facto household population who slept under an insecticide treated net the night before the survey

Usage

ML_NETU_P_ITN(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_CUSA_W_MOD",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::fp_cruse_mod)

## End(Not run)

ML_PMAL_C_RDT PRdata Malaria prevalence according to RDT

Description

ML_PMAL_C_RDT PRdata Malaria prevalence according to RDT

Usage

ML_PMAL_C_RDT(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "ML_PMAL_C_RDT",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::ML_PMAL_C_RDT)

## End(Not run)

PR_DESL_W_WNM

Description

PR_DESL_W_WNM

Usage

PR_DESL_W_WNM(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "PR_DESL_W_WNM", year = 2018)

## End(Not run)

AH_TOBC_W_OTH

Description

AH_TOBC_W_OTH

Usage

RH_ANCN_W_N01(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "RH_ANCN_W_N01", year = 2018)

## End(Not run)

RH_ANCN_W_N4F IRdata Antenatal visits for pregnancy: 4+ visits FIVE year

Description

RH_ANCN_W_N4F IRdata Antenatal visits for pregnancy: 4+ visits FIVE year

Usage

RH_ANCN_W_N4F(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::RH_ANCN_W_N4P)

## End(Not run)

RH_ANCN_W_N4P IRdata Antenatal visits for pregnancy: 4+ visits TWO year

Description

RH_ANCN_W_N4P IRdata Antenatal visits for pregnancy: 4+ visits TWO year

Usage

RH_ANCN_W_N4P(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::RH_ANCN_W_N4P)

## End(Not run)

RH_ANCN_W_N4P IRdata Antenatal visits for pregnancy: no visits TWO year

Description

RH_ANCN_W_N4P IRdata Antenatal visits for pregnancy: no visits TWO year

Usage

RH_ANCN_W_NON(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_NON",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::RH_ANCN_W_NON)

## End(Not run)

RH_DELA_C_SKF BRdata Assistance during delivery from a skilled provider

Description

RH_DELA_C_SKF BRdata Assistance during delivery from a skilled provider

Usage

RH_DELA_C_SKF(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_DELA_C_SKF",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::RH_DELA_C_SKF)

## End(Not run)

RH_DELA_C_SKP BRdata Assistance during delivery from a skilled provider

Description

RH_DELA_C_SKP BRdata Assistance during delivery from a skilled provider

Usage

RH_DELA_C_SKP(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_DELA_C_SKP",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::RH_DELA_C_SKP)

## End(Not run)

RH_DELP_C_DHF

Description

RH_DELP_C_DHF

Usage

RH_DELP_C_DHF(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "RH_DELP_C_DHF", year = 2018)

## End(Not run)

RH_DELP_C_DHT

Description

RH_DELP_C_DHT

Usage

RH_DELP_C_DHT(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "RH_DELP_C_DHT", year = 2018)

## End(Not run)

RH_DELP_C_HOM

Description

RH_DELP_C_HOM

Usage

RH_DELP_C_HOM(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "RH_DELP_C_DHT", year = 2018)

## End(Not run)

RH_DELP_C_HOT

Description

RH_DELP_C_HOT

Usage

RH_DELP_C_HOT(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "RH_DELP_C_DHT", year = 2018)

## End(Not run)

RH_DELP_C_PRT

Description

RH_DELP_C_PRT

Usage

RH_DELP_C_PRT(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "RH_DELP_C_PRT", year = 2018)

## End(Not run)

RH_DELP_C_PRV

Description

RH_DELP_C_PRV

Usage

RH_DELP_C_PRV(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "RH_DELP_C_PRV", year = 2018)

## End(Not run)

RH_DELP_C_PUB

Description

RH_DELP_C_PUB

Usage

RH_DELP_C_PUB(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "RH_DELP_C_PUB", year = 2018)

## End(Not run)

RH_DELP_C_PUT

Description

RH_DELP_C_PUT

Usage

RH_DELP_C_PUT(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "RH_DELP_C_PUT", year = 2018)

## End(Not run)

RH_PAHC_W_DIS IRdata Problems in accessing health care: Distance to health facility

Description

RH_PAHC_W_DIS IRdata Problems in accessing health care: Distance to health facility

Usage

RH_PAHC_W_DIS(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_CUSA_W_MOD",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::fp_cruse_mod)

## End(Not run)

RH_PAHC_W_MON IRdata Problems in accessing health care: Getting money for treatment

Description

RH_PAHC_W_MON IRdata Problems in accessing health care: Getting money for treatment

Usage

RH_PAHC_W_MON(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_CUSA_W_MOD",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::fp_cruse_mod)

## End(Not run)

RH_PAHC_W_PRM IRdata Problems in accessing health care: Getting permission to go for treatment

Description

RH_PAHC_W_PRM IRdata Problems in accessing health care: Getting permission to go for treatment

Usage

RH_PAHC_W_PRM(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "FP_CUSA_W_MOD",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::fp_cruse_mod)

## End(Not run)

RH_PCCT_C_DY2 Newborn's first postnatal checkup: 1-2 days RH_PCCT_C_DY2 in github IR

Description

RH_PCCT_C_DY2 Newborn's first postnatal checkup: 1-2 days RH_PCCT_C_DY2 in github IR

Usage

RH_PCCT_C_DY2(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "RH_PCCT_C_DY2", year = 2018)

## End(Not run)

RH_PCMT_W_DY2 Mother's first postnatal checkup: 1-2 days IR

Description

RH_PCMT_W_DY2 Mother's first postnatal checkup: 1-2 days IR

Usage

RH_PCMT_W_DY2(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "RH_PCMT_W_DY2", year = 2018)

## End(Not run)

RH_PCMT_W_NON No Mother's postnatal checkup in 42 days IR

Description

RH_PCMT_W_NON No Mother's postnatal checkup in 42 days IR

Usage

RH_PCMT_W_NON(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "RH_PCMT_W_NON", year = 2018)

## End(Not run)

WE_AWBT_M_ARG

Description

WE_AWBT_M_ARG

Usage

WE_AWBT_M_ARG(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WE_AWBT_M_ARG", year = 2018)

## End(Not run)

WE_AWBT_M_BFD

Description

WE_AWBT_M_BFD

Usage

WE_AWBT_M_BFD(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WE_AWBT_M_BFD", year = 2018)

## End(Not run)

WE_AWBT_M_OUT

Description

WE_AWBT_M_OUT

Usage

WE_AWBT_M_OUT(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WE_AWBT_M_OUT", year = 2018)

## End(Not run)

WE_AWBT_M_REF

Description

WE_AWBT_M_REF

Usage

WE_AWBT_M_REF(MRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WE_AWBT_M_REF", year = 2018)

## End(Not run)

WE_AWBT_W_ARG

Description

WE_AWBT_W_ARG

Usage

WE_AWBT_W_ARG(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WE_AWBT_W_ARG", year = 2018)

## End(Not run)

WE_AWBT_W_BFD

Description

WE_AWBT_W_BFD

Usage

WE_AWBT_W_BFD(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WE_AWBT_W_BFD", year = 2018)

## End(Not run)

WE_AWBT_W_NEG

Description

WE_AWBT_W_NEG

Usage

WE_AWBT_W_NEG(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WE_AWBT_W_NEG", year = 2018)

## End(Not run)

WE_AWBT_W_OUT

Description

WE_AWBT_W_OUT

Usage

WE_AWBT_W_OUT(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WE_AWBT_W_OUT", year = 2018)

## End(Not run)

WE_AWBT_W_REF

Description

WE_AWBT_W_REF

Usage

WE_AWBT_W_REF(IRdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WE_AWBT_W_REF", year = 2018)

## End(Not run)

WS_SRCE_H_USG Percentage of households whose main source of drinking water is an unprotected spring ph_wtr_source in github "unprotected spring" = 42, HR

Description

WS_SRCE_H_USG Percentage of households whose main source of drinking water is an unprotected spring ph_wtr_source in github "unprotected spring" = 42, HR

Usage

WS_SRCE_H_USG(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WS_SRCE_H_USG", year = 2018)

## End(Not run)

WS_SRCE_P_BAS PRdata Population using a basic water source

Description

WS_SRCE_P_BAS PRdata Population using a basic water source

Usage

WS_SRCE_P_BAS(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "WS_SRCE_P_BAS",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::WS_SRCE_P_BAS)

## End(Not run)

WS_TLET_H_IMP PRdata Percentage of households using an improved sanitation facility

Description

WS_TLET_H_IMP PRdata Percentage of households using an improved sanitation facility

Usage

WS_TLET_H_IMP(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "WS_TLET_H_IMP",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::WS_TLET_H_IMP)

## End(Not run)

WS_TLET_P_BAS PRdata Population with access to a basic sanitation service

Description

WS_TLET_P_BAS PRdata Population with access to a basic sanitation service

Usage

WS_TLET_P_BAS(Rdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "WS_TLET_P_BAS",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = NULL,
                         FUN = surveyPrev::WS_TLET_P_BAS)

## End(Not run)

WS_WTRT_P_BLC

Description

WS_WTRT_P_BLC

Usage

WS_WTRT_P_BLC(WASHdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WS_WTRT_P_BLC", year = 2018)

## End(Not run)

WS_WTRT_P_BOL

Description

WS_WTRT_P_BOL

Usage

WS_WTRT_P_BOL(WASHdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WS_WTRT_P_BOL", year = 2018)

## End(Not run)

WS_WTRT_P_SOL

Description

WS_WTRT_P_SOL

Usage

WS_WTRT_P_SOL(WASHdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WS_WTRT_P_SOL", year = 2018)

## End(Not run)

WS_WTRT_P_STN

Description

WS_WTRT_P_STN

Usage

WS_WTRT_P_STN(WASHdata)

Arguments

Value

A partially processed data.frame that will be used in surveyPrev::getDHSindicator. The whole function can be used as a parameter in surveyPrev::getDHSindicator

Author(s)

Miaolei Bao, Yunhan Wu, Qianyu Dong

Examples

## Not run: 
dhsData <- getDHSdata(country = "Zambia", indicator = "WS_WTRT_P_STN", year = 2018)

## End(Not run)

Admin 1 Polygon Map for Zambia.

Description

A SpatialPolygonsDataFrame corresponding to Zambia's admin-1 regions. The dataset is downloaded from GADM (https://gadm.org/data.html) version 4.1.

Usage

data(ZambiaAdm1)

Format

An object of class SpatialPolygonsDataFrame with 10 rows and 4 columns.

Admin 2 Polygon Map for Zambia.

Description

A SpatialPolygonsDataFrame corresponding to Zambia's admin-2 regions. The dataset is downloaded from GADM (https://gadm.org/data.html) version 4.1.

Usage

data(ZambiaAdm2)

Format

An object of class SpatialPolygonsDataFrame with 115 rows and 6 columns.

Population estimates for Women of age 15 to 49 in Zambia in 2018.

Description

A list of three objects

• raster A 100m by 100m raster file for the population estimates for women of age 15 to 49 in Zambia in 2018

• admin1_urban A data frame specifying the proportion of urban population (as defined by those living in regions designated as urban in the previous census) for Women of age 15 to 49 in Zambia in 2018, in each admin1 region.

• admin2_urban A data frame specifying the proportion of urban population (as defined by those living in regions designated as urban in the previous census) for Women of age 15 to 49 in Zambia in 2018, in each admin2 region. The corresponding admin1 region name is also included.

The dataset is downloaded from WorldPop (https://hub.worldpop.org/geodata/summary?id=16429) and post processed.

Usage

data(ZambiaPopWomen)

Format

An object of class list of length 4.

Create new row to add in indicatorList.

Description

Create new row to add in indicatorList.

Usage

addNewIndicator(
  new_id,
  dictionary,
  IR = FALSE,
  PR = FALSE,
  KR = FALSE,
  BR = FALSE,
  HR = FALSE,
  MR = FALSE,
  AR = FALSE,
  CR = FALSE
)

Arguments

Value

The a row to rbind into indicator_df

Author(s)

Qianyu Dong

Examples

## Not run: 
newrow=addNewIndicator(new_id="RH_DELP_C_HOM", dictionary= sae4health::DHS_ind_dictionary,
IR=FALSE, PR=FALSE, KR=FALSE, BR=TRUE,
HR=FALSE, MR=FALSE, AR=FALSE, CR=FALSE )
newrow <- newrow[, names(indicatorList)]
indicatorList <- rbind(indicatorList, newrow)

## End(Not run)

Attach upper-level admin names to lower-level polygons

Description

Maps each polygon in a lower administrative layer (e.g., ADM2) to its containing polygon in an upper layer (e.g., ADM1), populating an upper-level name column. If containment fails for some polygons (e.g., due to slivers or minor topology issues), a nearest-centroid fallback is used.

Usage

addUpper(
  poly.adm.upper,
  poly.adm,
  by.adm,
  by.adm.upper,
  out_lower = "NAME_2",
  out_upper = "NAME_1",
  sort = TRUE
)

Arguments

Details

Inputs may be either sf or sp polygon data. If sp inputs are provided, they are converted to sf internally. Containment is determined via sf::st_within(). For polygons not matched by containment, the function uses sf::st_nearest_feature() on centroids (sf::st_centroid()) to assign an upper-level name.

Value

An sf object at the target (lower) admin level containing:

• out_lower: lower-level admin name (copied from by.adm)

• out_upper: upper-level admin name (derived via spatial matching)

• geometry: polygon geometry

• admin2.name.full: convenience concatenation paste0(out_upper, "_", out_lower)

Examples

## Not run: 
library(sf)
adm1 <- st_read("geoBoundaries/geoBoundaries-NGA-ADM1-all/geoBoundaries-NGA-ADM1.shp")
adm2 <- st_read("geoBoundaries/geoBoundaries-NGA-ADM2-all/geoBoundaries-NGA-ADM2.shp")

# If both layers use "shapeName" but you want outputs named NAME_1/NAME_2:
res <- addUpper(
  poly.adm.upper = adm1,
  poly.adm       = adm2,
  by.adm         = "shapeName",   # lower-level names
  by.adm.upper   = "shapeName",   # upper-level names
  out_lower      = "NAME_2",
  out_upper      = "NAME_1",
  sort           = TRUE
)

# If the columns are already NAME_1 / NAME_2:
res2 <- addUpper(
  poly.adm.upper = adm1,
  poly.adm       = adm2,
  by.adm         = "NAME_2",
  by.adm.upper   = "NAME_1"
)

## End(Not run)

Get admin information

Description

This function get admin information including name, character, population and unban/rural proportion.

Usage

adminInfo(
  poly.adm,
  by.adm,
  admin,
  by.adm.upper = NULL,
  agg.pop = NULL,
  proportion = NULL
)

Arguments

Value

This function returns the 1. dataframe that contains admin 1 and admin 2 information and coordinates for each cluster and 2. Adjacency matrix.

Author(s)

Qianyu Dong

Examples

# For sp::SpatialPolygonsDataFrame object
data(ZambiaAdm1)
class(ZambiaAdm1)
info <- adminInfo(poly.adm=ZambiaAdm1, admin = 1, by.adm="NAME_1")
data(ZambiaAdm2)
class(ZambiaAdm2)
info2 <- adminInfo(poly.adm=ZambiaAdm2, admin = 2,by.adm="NAME_2",by.adm.upper="NAME_1")

# For sf object
geo.sf <- sf::st_as_sf(ZambiaAdm1)
info <- adminInfo(poly.adm=geo.sf, admin = 1,by.adm="NAME_1")

# To include the population information
data(ZambiaPopWomen)
info <- adminInfo(poly.adm = ZambiaAdm1,
                  admin = 1,by.adm="NAME_1",
                  agg.pop = ZambiaPopWomen$admin1_pop,
                  proportion = ZambiaPopWomen$admin1_urban )

Get population information

Description

This function aggregate population to particular admin levels

Usage

aggPopulation(tiff, fact = 10, poly.adm, by.adm, by.adm.upper = NULL)

Arguments

Value

This function returns the dataset that contain district name and population for given tiff files and polygons of admin level

Author(s)

Qianyu Dong

Examples

## Not run: 
library(raster)

# Download and find total population in age group 0 to 12 months
pre <- "https://data.worldpop.org/GIS/AgeSex_structures/"
f <- paste0(pre, "Global_2000_2020/2018/ZMB/zmb_f_0_2018.tif")
m <- paste0(pre, "Global_2000_2020/2018/ZMB/zmb_m_0_2018.tif")
pop_f_0 <- raster(f)
pop_m_0 <- raster(m)

pop_raster <- pop_f_0 + pop_m_0

# admin1 population
agg.pop1 <- aggPopulation(
  tiff = pop_raster,
  poly.adm = ZambiaAdm1,
  by.adm = "NAME_1")


# admin2 population
agg.pop2 <- aggPopulation(
  tiff = ZambiaPopWomen_raster,
  poly.adm = ZambiaAdm2,
  by.adm = "NAME_2",
  by.adm.upper="NAME_1")


## End(Not run)

Get survey weight by admin levels

Description

This function aggregate survey weight to particular admin levels

Usage

aggSurveyWeight(
  data,
  cluster.info,
  admin,
  poly.adm = NULL,
  by.adm = NULL,
  by.adm.upper = NULL
)

Arguments

Value

This function returns the dataset that contain admin name and survey weight.

Author(s)

Qianyu Dong

Examples

## Not run: 

# admin1 population

year <- 2018
country <- "Zambia"
indicator="nmr"

geo <- getDHSgeo(country = country, year = year)
dhsData <- getDHSdata(country = country, indicator=indicator, year = year)
data<- getDHSindicator(dhsData, indicator = indicator)

poly.adm1=ZambiaAdm1
poly.adm2=ZambiaAdm2

cluster.info<-clusterInfo(geo=geo, poly.adm1=poly.adm1, poly.adm2=poly.adm2,
by.adm1 = "NAME_1",by.adm2 = "NAME_2")

agg.survey1<-aggSurveyWeight(data=data,cluster.info=cluster.info,admin=1)
agg.survey2<-aggSurveyWeight(data=data,cluster.info=cluster.info,admin=2,
                             poly.adm = poly.adm2,  by.adm="NAME_2",
                             by.adm.upper ="NAME_1")

## End(Not run)

Get cluster information

Description

This function add admin 1 and admin2 information to a particular DHS survey.

Usage

clusterInfo(
  geo,
  poly.adm1,
  poly.adm2 = NULL,
  by.adm1 = "NAME_1",
  by.adm2 = "NAME_2",
  map = FALSE
)

Arguments

Value

This function returns the dataset that contains admin 1 and admin 2 information and coordinates for each cluster.

Author(s)

Qianyu Dong

Examples

## Not run: 
geo <- getDHSgeo(country = "Zambia", year = 2018)
data(ZambiaAdm1)
data(ZambiaAdm2)
cluster.info <- clusterInfo(geo = geo,
                            poly.adm1 = ZambiaAdm1,
                            poly.adm2 = ZambiaAdm2)

## End(Not run)

Calculate cluster model estimates using beta binomial model

Description

This function calculate smoothed direct estimates at given admin level.

Usage

clusterModel(
  data,
  cluster.info,
  admin.info,
  X = NULL,
  X.unit = NULL,
  X.pixel = NULL,
  admin,
  CI = 0.95,
  model = c("bym2", "iid"),
  stratification = FALSE,
  aggregation = FALSE,
  nested = FALSE,
  interact = FALSE,
  overdisp.mean = 0,
  overdisp.prec = 0.4,
  pc.u = 1,
  pc.alpha = 0.01,
  pc.u.phi = 0.5,
  pc.alpha.phi = 2/3,
  ...
)

Arguments

Value

This function returns the dataset that contain district name and population for given tiff files and polygons of admin level,

Author(s)

Qianyu Dong

Examples

## Not run: 
geo <- getDHSgeo(country = "Zambia", year = 2018)
data(ZambiaAdm1)
data(ZambiaAdm2)
data(ZambiaPopWomen)
cluster.info <- clusterInfo(geo = geo,
                            poly.adm1 = ZambiaAdm1,
                            poly.adm2 = ZambiaAdm2)

# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")
admin.info1 <- adminInfo(poly.adm = ZambiaAdm1,
                        admin = 1,
                        agg.pop =ZambiaPopWomen$admin1_pop,
                        proportion = ZambiaPopWomen$admin1_urban)
cl_res_ad1 <- clusterModel(data=data,
                  cluster.info = cluster.info,
                  admin.info = admin.info1,
                  stratification = FALSE,
                  model = "bym2",
                  admin = 1,
                  aggregation = TRUE,
                  CI = 0.95)
cl_res_ad1$res.admin1

# compare with the DHS direct estimates
dhs_table <- get_api_table(country = "ZM",
                           survey = "ZM2018DHS",
                           indicator = "RH_ANCN_W_N4P",
                           simplify = TRUE)
subset(dhs_table, ByVariableLabel == "Five years preceding the survey")


## End(Not run)

Calculate cluster model estimates using beta binomial model for U5MR

Description

This function calculate smoothed direct estimates at given admin level.

Usage

clusterModel_u5mr(
  data,
  cluster.info,
  admin.info,
  X = NULL,
  X.unit = NULL,
  X.pixel = NULL,
  admin,
  CI = 0.95,
  model = c("bym2", "iid"),
  stratification = FALSE,
  aggregation = FALSE,
  nested = FALSE,
  interact = FALSE,
  overdisp.mean = 0,
  overdisp.prec = 0.4,
  pc.u = 1,
  pc.alpha = 0.01,
  pc.u.phi = 0.5,
  pc.alpha.phi = 2/3,
  age.space.group = c(1, 2, 2, 2, 3, 3, 3, 3)
)

Arguments

Value

This function returns the dataset that contain district name and population for given tiff files and polygons of admin level,

Summarize Sample and Event Information by Administrative Level

Description

Computes summary statistics on the number of sampled observations, events, and unique clusters at national, admin1, and admin2 levels. The function merges the input dataset with cluster- and admin-level metadata and returns counts of samples, events, and clusters per geographic unit.

Usage

datainfo(data, cluster.info, admin.info1 = NULL, admin.info2 = NULL)

Arguments

Details

The function performs left and right joins to associate each observation in data with its cluster and administrative region. It removes rows with missing values before summarizing. For each administrative level:

• n_samples: number of non-missing observations.

• n_events: number of cases where value == 1.

• n_clusters: number of distinct survey clusters.

If admin.info1 or admin.info2 is NULL, the corresponding summaries are omitted.

Value

A list with up to three data frames:

summary.ad0

National-level totals across all clusters.

summary.ad1

Admin1-level summaries (if admin.info1 provided).

summary.ad2

Admin2-level summaries (if admin.info2 provided).

Examples

## Not run: 
datainfo(
  data = data,
  cluster.info = cluster.info,
  admin.info1 = admin.info1,
  admin.info2 = admin.info2
)

## End(Not run)

Calculate direct estimates

Description

This function calculate direct estimates at given admin level.

Usage

directEST(
  data,
  cluster.info,
  admin,
  strata = "all",
  CI = 0.95,
  weight = c("population", "survey")[1],
  admin.info = NULL,
  aggregation = FALSE,
  alt.strata = NULL,
  var.fix = FALSE,
  threshold = 1e-12,
  ...
)

Arguments

Value

This function returns the dataset that contain district name and population for given tiff files and polygons of admin level,

Author(s)

Qianyu Dong

Examples

## Not run: 

##
## Direct estimation of ANC visit 4+ proportion
##

geo <- getDHSgeo(country = "Zambia", year = 2018)
data(ZambiaAdm1)
data(ZambiaAdm2)
data(ZambiaPopWomen)
cluster.info<-clusterInfo(geo=geo, poly.adm1=ZambiaAdm1, poly.adm2=ZambiaAdm2,
by.adm1 = "NAME_1",by.adm2 = "NAME_2")
# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")
res_ad1 <- directEST(data = data,
                  cluster.info = cluster.info,
                  admin = 1,
                  aggregation = FALSE)
res_ad1
# compare with the DHS direct estimates
dhs_table <- get_api_table(country = "ZM",
                           survey = "ZM2018DHS",
                           indicator = "RH_ANCN_W_N4P",
                           simplify = TRUE)
subset(dhs_table, ByVariableLabel == "Five years preceding the survey")

##
## Changing customized stratification variable
##

data_alt <- data
# Assuming the stratification is done with only admin1 area
# and not stratified by urban and rural
# Note that this is not the correct stratification, but we use
#  this as an illustration to create user-specified strata variable
data_alt$new_strata <- data_alt$v024
res_ad1_wrong <- directEST(data = data_alt,
                  cluster.info = cluster.info,
                  admin = 1,
                  aggregation = FALSE,
                  alt.strata = "new_strata")
res_ad1_wrong

## End(Not run)

Helper function for the U5MR direct estimation

Description

Helper function for the U5MR direct estimation

Usage

directEST_u5mr(modt, regionVar)

Arguments

Value

a fitted object in the same format as smoothSurvey() function, to be slotted in directEST() internal script.

Calculate direct estimates

Description

This function calculate direct estimates at given admin level.

Usage

directEST_varfix(
  data,
  cluster.info,
  admin,
  strata = "all",
  CI = 0.95,
  weight = c("population", "survey")[1],
  admin.info = NULL,
  aggregation = FALSE,
  alt.strata = NULL,
  var.fix = TRUE,
  eps = 1e-12,
  floor_var = 1e-12,
  tol = 1e-12,
  all.fix = FALSE,
  ...
)

Arguments

Value

This function returns the dataset that contain district name and population for given tiff files and polygons of admin level,

Examples

## Not run: 

##
## Direct estimation of ANC visit 4+ proportion
##

geo <- getDHSgeo(country = "Zambia", year = 2018)
data(ZambiaAdm1)
data(ZambiaAdm2)
data(ZambiaPopWomen)
cluster.info<-clusterInfo(geo=geo, poly.adm1=ZambiaAdm1, poly.adm2=ZambiaAdm2,
by.adm1 = "NAME_1",by.adm2 = "NAME_2")
# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")
res_ad1 <- directEST_new(data = data,
                  cluster.info = cluster.info,
                  admin = 1,
                  aggregation = FALSE)

## End(Not run)

Plot exceedance probability of model results

Description

This function return a map of exceedance probability for given model results.

Usage

exceedPlot(
  x,
  exceed = TRUE,
  direction = 1,
  threshold = NA,
  geo = geo,
  by.geo = NULL,
  ylim = NULL,
  ...
)

Arguments

Value

This function returns a map showing probability of prevalence over/under the threshold.

Author(s)

Zehang Li, Qianyu Dong

Examples

## Not run: 

geo <- getDHSgeo(country = "Zambia", year = 2018)
data(ZambiaAdm1)
data(ZambiaAdm2)
data(ZambiaPopWomen)
cluster.info <- clusterInfo(geo = geo,
                            poly.adm1 = ZambiaAdm1,
                            poly.adm2 = ZambiaAdm2)

# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")
admin.info2 <- adminInfo(poly.adm = ZambiaAdm2,
                        admin = 2,
						   by.adm="NAME_2",
						   by.adm.upper = "NAME_1")
cl_res_ad2_unstrat <- clusterModel(data = data,
                  cluster.info = cluster.info,
                  admin.info = admin.info2,
                  stratification = FALSE,
                  model = "bym2",
                  admin = 2,
                  aggregation = TRUE,
                  CI = 0.95)
ZambiaAdm2$admin2.name.full <- paste0(ZambiaAdm2$NAME_1,
									     "_",
										 ZambiaAdm2$NAME_2)
exceedPlot(cl_res_ad2_unstrat, threshold = 0.5,
			  exceed = TRUE, direction = -1,
			  geo = ZambiaAdm2, by.geo = "admin2.name.full")
exceedPlot(cl_res_ad2_unstrat, threshold = 0.5,
			  exceed = FALSE, direction = -1,
			  geo = ZambiaAdm2, by.geo = "admin2.name.full")


## End(Not run)

Calculate smoothed direct estimates

Description

This function calculate smoothed direct estimates at given admin level.

Usage

fhModel(
  data,
  cluster.info,
  admin.info = NULL,
  X = NULL,
  nested = FALSE,
  admin,
  CI = 0.95,
  model = c("bym2", "iid"),
  aggregation = FALSE,
  alt.strata = NULL,
  var.fix = FALSE,
  ...
)

Arguments

Value

This function returns the dataset that contain district name and population for given tiff files and polygons of admin level,

Author(s)

Qianyu Dong

Examples

## Not run: 
geo <- getDHSgeo(country = "Zambia", year = 2018)
data(ZambiaAdm1)
data(ZambiaAdm2)
data(ZambiaPopWomen)
cluster.info <- clusterInfo(geo = geo,
                            poly.adm1 = ZambiaAdm1,
                            poly.adm2 = ZambiaAdm2)

# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)

data <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")
admin.info1 <- adminInfo(poly.adm = ZambiaAdm1,
                        admin = 1,
                        by.adm = "NAME_1",
                        agg.pop =ZambiaPopWomen$admin1_pop,
                        proportion = ZambiaPopWomen$admin1_urban)
smth_res_ad1 <- fhModel(data,
                       cluster.info = cluster.info,
                       admin.info = admin.info1,
                       admin = 1,
                       model = "bym2",
                       aggregation = F)
smth_res_ad1

## End(Not run)

Extract Covariate Data from A list of Rasters

Description

This function aligns raster covariates to a population density grid, extracts values for a national grid, associates administrative information, and prepares covariates for cluster-based data.

Usage

getCovariate(
  tiffs,
  tiff.population,
  UR.surface = NULL,
  cluster.info,
  poly.adm,
  by.adm,
  by.adm.upper,
  standardize = FALSE,
  na.rm = FALSE,
  fact = 1
)

Arguments

Details

The function follows these steps: 1. Converts 'poly.adm' to an 'sf' object. 2. Aligns rasters in 'tiffs' to match the 'tiff.population' grid using bilinear resampling. 3. Aggregates raster resolution if 'fact' is greater than 1. 4. Extracts pixel center coordinates and values for the national grid. 5. Matches pixel locations to administrative boundaries. 6. Extracts raster values at cluster locations.

Value

A list with two elements:

Examples

## Not run: 

kenya_cov <- getCovariate(
    tiffs = cov_raster_stack,
    tiff.population = avg.pop,
    UR.surface = UR_surface,
    cluster.info = cluster.info,
    poly.adm = poly.adm2,
    by.adm = 'NAME_2',
    by.adm.upper = 'NAME_1',
    standardize=FALSE,
.    na.rm=FALSE,
    fact = 1)


## End(Not run)

Download DHS survey data

Description

This function downloads DHS data for a particular country and survey.

Usage

getDHSdata(country, indicator = NULL, Recode = NULL, year, SurveyType = "DHS")

Arguments

Value

This function returns the survey dataset that contains the indicator.

Author(s)

Qianyu Dong

Examples

## Not run: 
# When indicator is known, download only the relevant file
# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)

# When indicator is NULL or not recognized, download all files
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = NULL,
                                 year = 2018)
names(dhsData)

## End(Not run)

Download DHS geo data

Description

This function downloads cluster's coordinate data for country and survey.

Usage

getDHSgeo(country, year)

Arguments

Value

The function returns a spatial point dataset with coordinates for each cluster based on the chosen survey and year.

Author(s)

Qianyu Dong

Examples

## Not run: 
geo <- getDHSgeo(country = "Zambia", year = 2018)

## End(Not run)

Process DHS data

Description

This function processes DHS data from getDHSdata function.

Usage

getDHSindicator(
  Rdata,
  indicator = NULL,
  FUN = NULL,
  nmr.year = 10,
  filter = NULL,
  yesCondition = NULL,
  noCondition = NULL
)

Arguments

Value

The function returns processed survey data that contains the indicator of interests.

Author(s)

Qianyu Dong

Examples

## Not run: 
# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData1 <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data1 <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")

#------------------------------------------------------------------#
# User-specified function to process the data
# For example see the internal function surveyPrev::AN_ANEM_W_ANY
#------------------------------------------------------------------#
dhsData2 <- getDHSdata(country = "Zambia",
                                 indicator = NULL,
                                 year = 2018)
data2 <- getDHSindicator(dhsData2, indicator = NULL,
                         FUN = surveyPrev::AN_ANEM_W_ANY)
# which should be identical to the following
dhsData3 <- getDHSdata(country = "Zambia",
                                 indicator = "womananemia",
                                 year = 2018)
data3 <- getDHSindicator(dhsData3, indicator = "womananemia")

#------------------------------------------------------------------#
# User-specified filtering condition
# Demonstrating NMR data preparation by specifying how to subset data
#    and specify the outcome variable and its levels
#------------------------------------------------------------------#
Recode <- "Births Recode"
dhsData4 <- getDHSdata(country = "Zambia", indicator = NULL,
                       Recode=Recode,year = "2018")
#
# Here we filter the births to be within the last 10 years
#   this is specified by condition = "v008 - b3 < 120"
# b3 is the date of births in CMC format
# v008 is the date of interview in CMC format
# the difference is the number of months between the two dates
# b7 is the age of death for the child. We consider neonatal deaths where
#   b7 = 0.
# b7 = NA when the child is alive at the time of interview.
data4 <- getDHSindicator(Rdata = dhsData4,
                        indicator = NULL,
                        filter = "v008 - b3 < 120",
                        yesCondition = "b7 == 0",
                        noCondition = "b7 > 0 | is.na(b7)")

# This will return the same dataset as below
data5 <- getDHSindicator(Rdata = dhsData4, indicator = "nmr")

# Notice that filter can have more than one conditions specified by vector
# The following four specifications lead to the same dataset for
#  neonatal deaths in the last 5 years
data6a <- getDHSindicator(Rdata = dhsData4,
                        indicator = NULL,
                        filter = "v008 - b3 < 120 & v008 - b3 < 60",
                        yesCondition = "b7 == 0",
                        noCondition = "b7 > 0 | is.na(b7)")
data6b <- getDHSindicator(Rdata = dhsData4,
                        indicator = NULL,
                        filter = c("v008 - b3 < 120", "v008 - b3 < 60"),
                        yesCondition = "b7 == 0",
                        noCondition = "b7 > 0 | is.na(b7)")
data6c <- getDHSindicator(Rdata = dhsData4,
                        indicator = NULL,
                        filter = "v008 - b3 < 60",
                        yesCondition = "b7 == 0",
                        noCondition = "b7 > 0 | is.na(b7)")
data7 <- getDHSindicator(Rdata = dhsData4, indicator = "nmr", nmr.year = 5)

## End(Not run)

Function to threshold population raster to obtain urban/rural fractions by Admin1 and Admin2 areas

Description

This function computes the urban proportion at a given survey year. It requires two population raster files and urban population fraction by admin 1 area from the census. The census year overall population raster is used to partition the grids into urban and rural pixels, based on the urban population fractions in a given area at the census year. The thresholding process is performed by first sorting the pixels from high to low population density, and find a threshold such that the fraction of population above this threshold matches the urban population fraction from the census. This step defines the urbanicity of each pixel. In the second step, for any given year's raster for a specific (sub-)population (e.g., specific age groups), we aggregate the population in the urban pixels defined in the previous step to compute urban proportion for the (sub-)population, within both admin1 and admin2 regions.

Usage

getUR(
  tiff.census,
  tiff.survey,
  prop.census,
  fact = 10,
  poly.adm1,
  poly.adm2,
  varname1,
  varname2
)

Arguments

Value

a list of two data frames for admin 1 and admin 2 urban ratios and UR surface where 1 for urban.

Examples

## Not run: 
# ----------------------------------------------------------------------#
# Here we consider the example of computing urban/rural fraction for
#  Zambia 2018 DHS for the sub-population of children under 1 years old.
# This survey is based on sampling frame from the 2010 Zambia Census.
# ----------------------------------------------------------------------#
#
# From Table A1 of Zambia 2013-2014 DHS final report, we can obtain the fraction of
#   urban population by Admin 1 areas in the 2010 survey.
# Notice that in the appendix of the 2018 DHS final report,
#   only distribution of household is reported and not population size by urbanicity.
# When the table is not provided in the DHS report, you need to find it from
#   the census website directly.
# Please note that the admin1 column needs to match the admin 1 names in the
#   Admin 1 spatial polygon file exactly.
#   For example, here we change "Northwestern" to "North-Western"

urban.frac <- data.frame(
		admin1 = c('Central', 'Copperbelt', 'Eastern',
				   'Luapula', 'Lusaka', 'Muchinga',
					'North-Western', 'Northern', 'Southern','Western'),
		frac = c(0.2513, 0.809, 0.1252,
					0.1963, 0.8456, 0.1714,
					0.2172, 0.1826, 0.2448, 0.1474))
# The corresponding census year population tiff can be found at:
# https://data.worldpop.org/GIS/Population/Global_2000_2020_1km_UNadj/

# The code below downloads the file from the internet directly
# You can also download the file directly and read into R
link1="https://data.worldpop.org/GIS/Population/Global_2000_2020_1km_UNadj/"
file1="2010/ZMB/zmb_ppp_2010_1km_Aggregated_UNadj.tif"
tempfile1 = tempfile()
download.file(paste0(link1, file1), destfile = tempfile1,
								method = "libcurl", mode="wb")
library(raster)
tiff1 <- raster(tempfile1)

# https://hub.worldpop.org/geodata/summary?id=16429
# Here we compute population fractions for 0-1 year old population.
# The from the same link below
link2="https://data.worldpop.org/GIS/AgeSex_structures/Global_2000_2020/"
# The two files are for female and male population respectively,
file2f="2018/ZMB/zmb_f_0_2018.tif"
file2m="2018/ZMB/zmb_f_0_2018.tif"

# Since the two files are very large, we recommend downloading them
#   mannually and then load them into R.
tiff2f <- raster("zmb_f_0_2018.tif")
tiff2m <- raster("zmb_m_0_2018.tif")
tiff2 <- tiff2f + tiff2m

frac <- getUR(tiff.census = tiff1, tiff.survey = tiff2,
				 prop.census = urban.frac, fact = 10,
				 poly.adm1 = ZambiaAdm1, poly.adm2 = ZambiaAdm2,
				 varname1 = "NAME_1", varname2 = "NAME_2")

library(SUMMER)
mapPlot(frac$admin1.ur, geo = ZambiaAdm1,
		   by.data = "admin1.name", by.geo = "NAME_1", variable = "urban")
mapPlot(frac$admin2.ur, geo = ZambiaAdm2,
		   by.data = "admin2.name", by.geo = "NAME_2", variable = "urban")
# Compare with the proportion of Women 14-49 years old in the built-in data
# These two plots should be similar but not identical
#   since the population is different
mapPlot(ZambiaPopWomen$admin2_urban, geo = ZambiaAdm2,
		   by.data = "admin2.name", by.geo = "NAME_2", variable = "urban")


## End(Not run)

Function to obtain subnational estimates from DHS API

Description

Function to obtain subnational estimates from DHS API

Usage

get_api_table(country, survey, indicator, simplify = TRUE, admin = 1)

Arguments

Value

a data frame of the DHS indicator estimates

Examples

## Not run: 
# country:  Zambia
# survey: 2018 DHS
# indicator: Percentage of children stunted
#             (below -2 SD of height for age
#              according to the WHO standard)
dhs_table <- get_api_table(country = "ZM",
                           survey = "ZM2018DHS",
                           indicator = "CN_NUTS_C_HA2",
                           simplify = TRUE)
dhs_table

## End(Not run)

Download geoBoundaries Shapefile as sf Object

Description

Retrieves official administrative boundary shapefiles from the [geoBoundaries](https://www.geoboundaries.org/) API for a given country ISO3 code and administrative level. Returns the data as an 'sf' object for direct spatial use.

Usage

get_geoBoundaries(iso3, adm = "ADM1", release = "gbOpen")

Arguments

Value

An 'sf' object containing the requested administrative boundaries.

Examples

## Not run: 
# Download Nigeria Admin 1 boundaries
nga_adm1 <- get_geoBoundaries("NGA", adm = "ADM1")

# Download Burkina Faso Admin 2 boundaries from the authoritative release
bfa_adm2 <- get_geoBoundaries("BFA", adm = "ADM2", release = "gbAuthoritative")

## End(Not run)

Table of supported DHS indicators.

Description

A data frame listing the DHS indicators supported by the package, including their IDs, descriptions, full definitions, associated DHS chapters, and the recode files (IR, PR, KR, BR, HR, MR, AR, CR) required to compute them.

Usage

data(indicatorList)

Format

A data frame with 182 rows and 15 columns:

Chap_abbrev

Chapter acronym.

ID

DHS standard indicator ID.

Description

Short label of the indicator.

Full_definition

Full definition of the indicator.

Topic

Chapter topic the indicator belongs to.

IR, PR, KR, BR, HR, MR, AR, CR

Logical flags indicating which DHS recode files are required.

Chapter

DHS chapter number.

Title

DHS chapter title.

Get scatter plot for any two model results

Description

This function return scatter plot at admin 1 level for any two model results

Usage

intervalPlot(
  admin = 0,
  compare = FALSE,
  model = NULL,
  group = FALSE,
  sort_by = NULL,
  decreasing = FALSE
)

Arguments

Value

This function returns the dataset that contain district name and population for given tiff files and polygons of admin level.

Author(s)

Qianyu Dong

Examples

## Not run: 

geo <- getDHSgeo(country = "Zambia", year = 2018)
data(ZambiaAdm1)
data(ZambiaAdm2)
data(ZambiaPopWomen)
cluster.info <- clusterInfo(geo = geo,
                            poly.adm1 = ZambiaAdm1,
                            poly.adm2 = ZambiaAdm2)

# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")
admin.info2 <- adminInfo(poly.adm = ZambiaAdm2,
                        admin = 2,
                        agg.pop =ZambiaPopWomen$admin2_pop,
                        proportion = ZambiaPopWomen$admin2_urban)
 # unstratified model
cl_res_ad2_unstrat <- clusterModel(data = data,
                  cluster.info = cluster.info,
                  admin.info = admin.info2,
                  stratification = FALSE,
                  model = "bym2",
                  admin = 2,
                  aggregation = TRUE,
                  CI = 0.95)

head(cl_res_ad2_unstrat$res.admin2)
head(cl_res_ad2_unstrat$agg.admin1)
plots <- intervalPlot(cl_res_ad2_unstrat)
plots[["Central"]]

 # unstratified model
cl_res_ad2 <- clusterModel(data = data,
                  cluster.info = cluster.info,
                  admin.info = admin.info2,
                  stratification = TRUE,
                  model = "bym2",
                  admin = 2,
                  aggregation = TRUE,
                  CI = 0.95)
head(cl_res_ad2$res.admin2)
head(cl_res_ad2$agg.admin1)
plots <- intervalPlot(cl_res_ad2)
plots[["Central"]]

library(patchwork)
wrap_plots(plots, ncol = 5)


## End(Not run)

Indicator matching table.

Description

A data frame with DHS indicator information used to match across different code bases.

Usage

data(match_all_result)

Format

An object of class data.frame with 146 rows and 21 columns.

static prevalence map for any subnational level

Description

produce static map for any subnational level, with the option to focus on one admin-1 level

Usage

prevMap(
  res.obj,
  poly.shp,
  admin1.focus = NULL,
  value.to.plot = "mean",
  map.title = NULL,
  legend.label = "Estimates",
  threshold.p = NULL,
  color.palette = NULL,
  color.reverse = T,
  value.range = NULL,
  ...
)

Arguments

Value

summer map object

Examples

## Not run: 
geo <- getDHSgeo(country = "Zambia", year = 2018)
cluster.info <- clusterInfo(geo = geo,
                            poly.adm1 = ZambiaAdm1,
                            poly.adm2 = ZambiaAdm2)
# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")
admin.info2 <- adminInfo(poly.adm = sf::st_as_sf(ZambiaAdm2), 
                         admin = 2, 
                         by.adm = "NAME_2", 
                         by.adm.upper = "NAME_1")
cl_res_ad2 <- clusterModel(data=data,
                  cluster.info = cluster.info,
                  admin.info = admin.info2,
                  model = "bym2",
                  admin = 2)

prevMap.adm2.central <- prevMap(res.obj=cl_res_ad2, 
                                       poly.shp=poly.adm2,
                                       admin1.focus = "Central")

## End(Not run) 

leaflet (interactive) prevalence map for any subnational level

Description

produce interactive map for any subnational level, with the option to focus on one admin-1 level

Usage

prevMap.web(
  res.obj,
  poly.shp,
  admin1.focus = NULL,
  color.palette = NULL,
  value.to.plot = "mean",
  value.range = NULL,
  num_bins = NULL,
  legend.label = "Estimates",
  map.title = NULL,
  color.reverse = T,
  no.hatching = F,
  hatching.density = 12,
  use.basemap = NULL,
  threshold.p = NULL,
  legend.color.reverse = T
)

Arguments

Value

leaflet map object

Examples

## Not run: 
geo <- getDHSgeo(country = "Zambia", year = 2018)
cluster.info <- clusterInfo(geo = geo,
                            poly.adm1 = ZambiaAdm1,
                            poly.adm2 = ZambiaAdm2)
# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")
poly.adm2 <- sf::st_as_sf(ZambiaAdm2)
admin.info2 <- adminInfo(poly.adm = poly.adm2, 
                         admin = 2, 
                         by.adm = "NAME_2", 
                         by.adm.upper = "NAME_1")
cl_res_ad2 <- clusterModel(data=data,
                  cluster.info = cluster.info,
                  admin.info = admin.info2,
                  model = "bym2",
                  admin = 2)
prevMap.adm2.central <- prevMap.web(res.obj=cl_res_ad2, 
                                              poly.shp=poly.adm2,
                                              admin1.focus = "Central")

## End(Not run) 

Get ranking plot of model results

Description

This function return scatter plot at admin 1 or 2 level for given model results.

Usage

rankPlot(x, direction = 1)

Arguments

Value

This function returns a ranking plot.

Author(s)

Zehang Li, Qianyu Dong

Examples

## Not run: 

geo <- getDHSgeo(country = "Zambia", year = 2018)
data(ZambiaAdm1)
data(ZambiaAdm2)
data(ZambiaPopWomen)
cluster.info <- clusterInfo(geo = geo,
                            poly.adm1 = ZambiaAdm1,
                            poly.adm2 = ZambiaAdm2)

# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")
admin.info2 <- adminInfo(poly.adm = ZambiaAdm2,
                        admin = 2,
						   by.adm="NAME_2",
						   by.adm.upper = "NAME_1")
cl_res_ad2_unstrat <- clusterModel(data = data,
                  cluster.info = cluster.info,
                  admin.info = admin.info2,
                  stratification = FALSE,
                  model = "bym2",
                  admin = 2,
                  aggregation = TRUE,
                  CI = 0.95)
rankPlot(cl_res_ad2_unstrat)


## End(Not run)

ridge plot for prevalence

Description

static ridge plot for posterior densities

Usage

ridgeprevPlot(
  res.obj,
  admin1.focus = NA,
  plot.extreme.num = 8,
  legend.label = "Value",
  color.reverse = T,
  plot.format = c("Long", "Wide")[1],
  top.bottom.label = c("Top", "Bottom")
)

Arguments

Value

ggplot2 object

Examples

## Not run: 
geo <- getDHSgeo(country = "Zambia", year = 2018)
cluster.info <- clusterInfo(geo = geo,
                            poly.adm1 = ZambiaAdm1,
                            poly.adm2 = ZambiaAdm2)
# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")
poly.adm1 <- sf::st_as_sf(ZambiaAdm1)
admin.info1 <- adminInfo(poly.adm = poly.adm1, 
                         admin = 1, 
                         by.adm = "NAME_1")
cl_res_ad1 <- clusterModel(data=data,
                  cluster.info = cluster.info,
                  admin.info = admin.info1,
                  stratification = FALSE,
                  model = "bym2",
                  admin = 1,
                  aggregation = TRUE,
                  CI = 0.95)
 
ridgeprevPlot(cl_res_ad1, plot.extreme.num=5)


## End(Not run)

Get scatter plot for any two model results

Description

This function return scatter plot at admin 1 level for any two model results

Usage

scatterPlot(
  res1,
  value1,
  res2,
  value2,
  label1,
  label2,
  by.res1,
  by.res2,
  title
)

Arguments

Value

This function returns the dataset that contain district name and population for given tiff files and polygons of admin level

Author(s)

Qianyu Dong

Examples

## Not run: 
geo <- getDHSgeo(country = "Zambia", year = 2018)
data(ZambiaAdm1)
data(ZambiaAdm2)
data(ZambiaPopWomen)
cluster.info <- clusterInfo(geo = geo,
                            poly.adm1 = ZambiaAdm1,
                            poly.adm2 = ZambiaAdm2)

# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")
admin.info1 <- adminInfo(poly.adm = ZambiaAdm1,
                        admin = 1,
                        agg.pop =ZambiaPopWomen$admin1_pop,
                        proportion = ZambiaPopWomen$admin1_urban)
smth_res_ad1 <- fhModel(data,
                       cluster.info = cluster.info,
                       admin.info = admin.info1,
                       admin = 1,
                       model = "bym2",
                       aggregation = F)

admin.info2 <- adminInfo(poly.adm = ZambiaAdm2,
                        admin = 2,
                        agg.pop =ZambiaPopWomen$admin2_pop,
                        proportion = ZambiaPopWomen$admin2_urban)
cl_res_ad2 <- clusterModel(data = data,
                  cluster.info = cluster.info,
                  admin.info = admin.info2,
                  stratification = FALSE,
                  model = "bym2",
                  admin = 2,
                  aggregation = TRUE,
                  CI = 0.95)

scatterPlot(
     res1 = smth_res_ad1,
     res2 = cl_res_ad2$agg.admin1,
     value1 = "value",
     value2 = "value",
     by.res1 = "admin1.name",
     by.res2 = "admin1.name",
     title = "Aggregated cluster model v.s. Fay–Herriot",
     label1 = "Fay–Herriot",
     label2 = "Aggregated cluster model")


## End(Not run)

web-based scatter plot

Description

interactive scatter plot comparing estimates from two methods for the same admin level

Usage

scatterPlot.web(
  res.obj.x,
  res.obj.y,
  value.to.plot = "mean",
  label.x = "Method 1 Estimates",
  label.y = "Method 2 Estimates",
  plot.title = NULL,
  interactive = T
)

Arguments

Value

plotly or ggplot2 object

Examples

## Not run: 
geo <- getDHSgeo(country = "Zambia", year = 2018)
cluster.info <- clusterInfo(geo = geo,
                            poly.adm1 = ZambiaAdm1,
                            poly.adm2 = ZambiaAdm2)
# "RH_ANCN_W_N4P" is an indicator for having more than four ANC visits.
#  In previous versions of the package, it is labeled "ancvisit4+".
dhsData <- getDHSdata(country = "Zambia",
                                 indicator = "RH_ANCN_W_N4P",
                                 year = 2018)
data <- getDHSindicator(dhsData, indicator = "RH_ANCN_W_N4P")
poly.adm2 <- sf::st_as_sf(ZambiaAdm2)
admin.info2 <- adminInfo(poly.adm = poly.adm2, 
                         admin = 2, 
                         by.adm = "NAME_2", 
                         by.adm.upper = "NAME_1")
res_adm2_cl <- clusterModel(data=data,
                  cluster.info = cluster.info,
                  admin.info = admin.info2,
                  model = "bym2",
                  admin = 2)
res_adm2_fh <- fhModel(data=data,
                  cluster.info = cluster.info,
                  admin.info = admin.info2,
                  model = "bym2",
                  admin = 2)

scatterPlot.web(res_adm2_cl, res_adm2_fh)

## End(Not run)