create_mortality_quality_report: Create Mortality Quality Report

In SaeedR1987/healthyr: REACH Nutrition & Health R Tools

Create Mortality Quality Report

Description

This function generates a summary table of the mortality data, either at an overall level or disaggregated by a specified grouping, such as team_id, cluster, or other.

Usage

create_mortality_quality_report(
  df,
  grouping = NULL,
  file_path = NULL,
  short_report = NULL,
  exp_sex_ratio = NULL,
  exp_ratio_0_4 = NULL,
  exp_ratio_2_5 = NULL,
  exp_ratio_5_10 = NULL,
  exp_hh_size = NULL
)

Arguments

df	Inputs a dataframe that has been standardized by the format_mortality_current_census function.
grouping	A character value specifying the column name by which you want to generate disaggregated results for for the mortality quality summary.
file_path	Inputs an optional character value specifying the file location to save a copy of the results.
short_report	Inputs a boolean value TRUE or FALSE to return just key variables. If FALSE, returns a dataframe of all the variables calculated.
exp_sex_ratio	Inputs a numeric value specifying the expected sex ratio in the population. If no value is given, a default value of 1:1 is used.
exp_ratio_0_4	Inputs a numeric value specifying the expected ratio of people under-5 years of age : people greater than or equal to 5 years of age in the population. If no value is given, a default of 0.25 is used, which is about 20% of the population is under-5. It is highly recommended to use an actual value specific to your context as this default ratio is likely not specific enough.
exp_ratio_2_5	Inputs a numeric value specifying the expected ratio of people under-5 years of age : people greater than or equal to 5 years of age in the population. If no value is given, a default of 0.7 is used, which is about 41% are children under-2 years of age out of the under-5 population. It is highly recommended to use an actual value specific to your context as this default ratio is likely not specific enough.
exp_ratio_5_10	Inputs a numeric value specifying the expected ratio of people under-5 years of age : people greater than or equal to 5 years of age in the population. If no value is given, a default of 1.1 is used, which is about 52% are children under-5 years of age out of the under-10 population. It is highly recommended to use an actual value specific to your context as this default ratio is likely not specific enough.
exp_hh_size	Inputs a numeric value specifying the expected average household size. If no value is given, a default of 5 is used It is highly recommended to use an actual value specific to your context as this default ratio is likely not specific enough.

Value

Returns a dataframe with summary indicators on the mortality data.

Examples

## Not run: create_mortality_quality_report(df)

SaeedR1987/healthyr documentation built on July 4, 2023, 11:17 p.m.