Skip to contents

This function categorizes handwashing facilities into "Basic," "Limited," or "No facility" based on survey data. It evaluates various parameters related to the availability of handwashing facilities and the presence of soap and water.

Usage

add_handwashing_facility_cat(
  df,
  survey_modality = "survey_modality",
  survey_modality_in_person = c("in_person"),
  survey_modality_remote = c("remote"),
  facility = "wash_handwashing_facility",
  facility_yes = "available",
  facility_no = "none",
  facility_no_permission = "no_permission",
  facility_undefined = "other",
  facility_observed_water = "wash_handwashing_facility_observed_water",
  facility_observed_water_yes = "water_available",
  facility_observed_water_no = "water_not_available",
  facility_observed_soap = "wash_handwashing_facility_observed_soap",
  facility_observed_soap_yes = "soap_available",
  facility_observed_soap_no = "soap_not_available",
  facility_observed_soap_alternative = "alternative_available",
  facility_reported = "wash_handwashing_facility_reported",
  facility_reported_yes = c("fixed_dwelling", "fixed_yard", "mobile"),
  facility_reported_no = c("none"),
  facility_reported_undefined = c("other", "dnk", "pnta"),
  facility_reported_no_permission_soap = "wash_soap_observed",
  facility_reported_no_permission_soap_yes = c("yes_soap_shown", "yes_soap_not_shown"),
  facility_reported_no_permission_soap_no = "no",
  facility_reported_no_permission_soap_undefined = c("dnk", "pnta"),
  facility_reported_no_permission_soap_type = "wash_soap_observed_type",
  facility_reported_no_permission_soap_type_yes = c("soap", "detergent"),
  facility_reported_no_permission_soap_type_no = "ash_mud_sand",
  facility_reported_no_permission_soap_type_undefined = c("other", "dnk", "pnta"),
  facility_reported_remote_soap = "wash_soap_reported",
  facility_reported_remote_soap_yes = "yes",
  facility_reported_remote_soap_no = "no",
  facility_reported_remote_soap_undefined = c("dnk", "pnta"),
  facility_reported_remote_soap_type = "wash_soap_reported_type",
  facility_reported_remote_soap_type_yes = c("soap", "detergent"),
  facility_reported_remote_soap_type_no = c("ash_mud_sand"),
  facility_reported_remote_soap_type_undefined = c("other", "dnk", "pnta")
)

Arguments

df

A data frame containing the survey data.

survey_modality

Column name for the survey modality (e.g., "survey_modality").

survey_modality_in_person

Options for the in-person survey modality.

survey_modality_remote

Options for the remote survey modality.

facility

Column name for the observed handwashing facility (e.g., "wash_handwashing_facility").

facility_yes

Response code indicating availability (e.g., "available").

facility_no

Response code indicating unavailability (e.g., "none").

facility_no_permission

Response code for cases with no permission to observe.

facility_undefined

Response code for undefined situations.

facility_observed_water

Column name for observed water availability (e.g., "wash_handwashing_facility_observed_water").

facility_observed_water_yes

Response code indicating water is available.

facility_observed_water_no

Response code indicating water is not available.

facility_observed_soap

Column name for observed soap availability (e.g., "wash_handwashing_facility_observed_soap").

facility_observed_soap_yes

Response code indicating soap is available.

facility_observed_soap_no

Response code indicating soap is not available.

facility_observed_soap_alternative

Response code for alternative cleaning agents.

facility_reported

Column name for reported handwashing facilities (e.g., "wash_handwashing_facility_reported").

facility_reported_yes

Response codes indicating reported availability (e.g., "fixed_dwelling", "fixed_yard", "mobile").

facility_reported_no

Response code indicating reported unavailability (e.g., "none").

facility_reported_undefined

Response codes for undefined reports.

facility_reported_no_permission_soap

Column name for reported soap availability under no permission conditions.

facility_reported_no_permission_soap_yes

Response codes indicating soap is shown under no permission conditions.

facility_reported_no_permission_soap_no

Response code indicating soap is not shown under no permission conditions.

facility_reported_no_permission_soap_undefined

Response codes for undefined situations under no permission conditions.

facility_reported_no_permission_soap_type

Column name for the type of soap reported under no permission conditions.

facility_reported_no_permission_soap_type_yes

Response codes indicating type of soap is shown.

facility_reported_no_permission_soap_type_no

Response code indicating type of soap is not shown.

facility_reported_no_permission_soap_type_undefined

Response codes for undefined types of soap reported under no permission conditions.

facility_reported_remote_soap

Column name for remote cases reporting soap availability.

facility_reported_remote_soap_yes

Response code indicating soap is available in remote cases.

facility_reported_remote_soap_no

Response code indicating soap is not available in remote cases.

facility_reported_remote_soap_undefined

Response codes for undefined situations in remote cases.

facility_reported_remote_soap_type

Column name for the type of soap reported in remote cases.

facility_reported_remote_soap_type_yes

Response codes indicating type of soap is available in remote cases.

facility_reported_remote_soap_type_no

Response code indicating type of soap is not available in remote cases.

facility_reported_remote_soap_type_undefined

Response codes for undefined types of soap reported in remote cases.

Value

A data frame with an additional column 'wash_handwashing_facility_jmp_cat': Categorized handwashing facilities: "Basic," "Limited," or "No Facility."