R/data.R

In ernestguevarra/squeacr: Semi-Quantitative Evaluation of Access and Coverage (SQUEAC) Tools in R

################################################################################
#
#'
#' MUAC at admission
#'
#' @format A named list with 12 tibbles:
#'
#' | *Telkuk* | MUAC at admission data for Telkuk locality |
#' | *Halfa* | MUAC at admission data for Halfa locality |
#' | *Kassala* | MUAC at admission data for Kassala locality |
#' | *Naher Atbara* | MUAC at admission data for Naher Atbara locality |
#' | *El Fasher* | MUAC at admission data for El Fasher locality |
#' | *Tawila* | MUAC at admission data for Tawila locality |
#' | *Kutumu* | MUAC at admission data for Kutumu locality |
#' | *Kalamendo* | MUAC at admission data for Kalamendo locality |
#' | *Medani Alkupra* | MUAC at admission data for Medani Alkupra locality |
#' | *South Gazira* | MUAC at admission data for South Gazira locality |
#' | *Sharg Algazira* | MUAC at admission data for Sharg Algazira locality |
#' | *Al Kamlin* | MUAC at admission data for Al Kamlin locality |
#'
#' @examples
#' muac_admission
#'
#' @source A CMAM programme evaluation in Sudan
#'
#'
#
################################################################################
"muac_admission"


################################################################################
#
#'
#' MUAC at admission in tidy format
#'
#' @format A tibble with 506 rows and 3 columns
#'
#' | **Variable** | **Description** |
#' | :--- | :--- |
#' | *muac* | Mid-upper arm circumference in centimetres |
#' | *district* | Name of district |
#' | *count* | Number of cases with specific MUAC |
#'
#' @examples
#' muac_admission
#'
#' @source A SQUEAC survey in Lokori, Kenya
#'
#'
#
################################################################################
"muac_admission_tidy"


################################################################################
#
#'
#' Routine CMAM monitoring data from Sudan
#'
#' @format A tibble with 8234 rows and 16 columns
#'
#' | **Variable** | **Description** |
#' | :--- | :--- |
#' | *State* | Name of state |
#' | *Locality* | Name of locality |
#' | *Beginning of Month* | Cases in programme at beginning of month |
#' | *New Admissions* | New cases admitted within the month |
#' | *Male* | New male cases admitted within the month |
#' | *Female* | New female cases admitted within the month |
#' | *Cured* | Number of cured cases within the month |
#' | *Death* | Number of cases who died within the month |
#' | *Default* | Number of cases who defaulted within the month |
#' | *Non-Responder* | Number of non-responder cases within the month |
#' | *Total Discharge* | Total number of discharges within the month |
#' | *RUTF Consumed* | Number of RUTF consumed |
#' | *Screening* | Screening |
#' | *Sites* | Sites |
#' | *Month* | Month |
#' | *Year* | Year |
#'
#' @examples
#' monitoring
#'
#' @source Federal Ministry of Health of Sudan
#'
#'
#
################################################################################
"monitoring"


################################################################################
#
#'
#' Seasonal calendar data for Sudan
#'
#' @format A tibble with 28 rows and 4 columns
#'
#' | **Variables** | **Description** |
#' | :--- | :--- |
#' | *event* | Name of seasonal calendar event or activity |
#' | *start* | Starting date of event/activity |
#' | *end* | Starting date of event/activity |
#' | *group* | Classification/group of activity or event |
#'
#' @examples
#' seasonal_calendar
#'
#' @source https://fews.net/east-africa/sudan/seasonal-calendar/december-2013
#'
#'
#
################################################################################
"seasonal_calendar"


################################################################################
#
#'
#' Outpatient Therapeutic Care Programme (OTP) beneficiaries data
#'
#' @format A tibble with 405 rows and 13 columns:
#'
#' | **Variable** | **Description** |
#' | :--- | :--- |
#' | *index* | Unique identifier |
#' | *state* | Name of state |
#' | *locality* | Name of locality |
#' | *health_facility* | Name of health facility |
#' | *age* | Age of child |
#' | *muac* | Mid-upper arm circumference (cms) at admission |
#' | *wt* | Weight (kgs) at admission |
#' | *ht* | Height (cms) at admission |
#' | *admDate* | Date of admission |
#' | *disDate* | Date of discharge |
#' | *diswt* | Weight (kgs) at discharge |
#' | *attended* | Number of OTP sessions attended |
#' | *exitType* | Type of exit (cured, dead, default or non-responder) |
#'
#' @examples
#' otp_beneficiaries
#'
#' @source Data collected from beneficiary cards from Kassala, North Darfur,
#'   and Algazira State, Sudan
#'
#
################################################################################
"otp_beneficiaries"


################################################################################
#
#'
#' Time-to-travel to health facilities for beneficiaries and volunteers
#'
#' @format A tibble with 165 rows and 9 columns:
#'
#' | **Variable** | **Description** |
#' | :--- | :--- |
#' | *State* | Name of state |
#' | *Locality* | Name of locality |
#' | *Health Facility* | Name of health facility |
#' | *Category* | Category of beneficiary or volunteer |
#' | *30 or less* | Travel time of 30 minutes or less |
#' | *31 to 60* | Travel time of 31 minutes to 60 minutes |
#' | *61 to 90* | Travel time of 61 minutes to 90 minutes |
#' | *91 to 120* | Travel time of 91 minutes to 120 minutes |
#' | *more than 120* | Travel time of more than 120 minutes |
#'
#' @examples
#' time_to_travel
#'
#' @source Data collected from beneficiary cards from Kassala State, Sudan
#'
#
################################################################################
"time_to_travel"