Skip to contents

Check whether IPC Acute Malnutrition (IPC AMN) sample size requirements were met

Source: R/ipc_amn_check.R
mw_check_ipcamn_ssreq.Rd

Evidence on the prevalence of acute malnutrition used in the IPC AMN can come from different sources: surveys, screenings or community-based surveillance system. The IPC set minimum sample size requirements for each source. This function helps in verifying whether the requirements were met or not depending on the source.

Usage

mw_check_ipcamn_ssreq(df, cluster, .source = c("survey", "screening", "ssite"))

Arguments

df

A dataset object of class data.frame to check.

cluster

A vector of class integer or character of unique cluster or screening or sentinel site IDs. If a character vector, ensure that names are correct and each name represents one location for accurate counts. If the class does not match the above expected type, the function will stop execution and return an error message indicating the type of mismatch.

.source

The source of evidence. A choice between "survey" for representative survey data at the area of analysis; "screening" for screening data; "ssite" for community-based sentinel site data.

Value

A summary table of class data.frame, of length 3 and width 1, for the check results. n_clusters is for the total number of unique clusters or screening or site IDs; n_obs for the correspondent total number of children in the dataset; and meet_ipc for whether the IPC AMN requirements were met.

References

IPC Global Partners. 2021. Integrated Food Security Phase Classification Technical Manual Version 3.1.Evidence and Standards for Better Food Security and Nutrition Decisions. Rome. Available at: https://www.ipcinfo.org/ipcinfo-website/resources/ipc-manual/en/.

Examples

mw_check_ipcamn_ssreq(
  df = anthro.01,
  cluster = cluster,
  .source = "survey"
)
#> # A tibble: 1 × 3
#>   n_clusters n_obs meet_ipc
#>        <int> <int> <chr>   
#> 1         30  1191 yes