score_WIS: Score WASH Insecurity Score (WIS)

In ElliottMess/WSC: Process data for the WASH Severity Classification (WSC)

Description

Score WASH Insecurity Score (WIS)

Usage

score_WIS(
  data,
  context_AP,
  context = NULL,
  WSC_AP = NULL,
  WIS_water = NULL,
  WIS_sanitation = NULL,
  WIS_final = NULL
)

Arguments

data	data.frame containing the data to be analysed with the function
context_AP	data.frame with context specific analysis plan (AP) that links the indicators in the WSC AP to the datasets used in the context analysis. See an example here or in WSC::context_AP.
context	Character string identifying the context to be used in the function call. This is to be used if multiple context (geographical or temporal) are being analysed. For instance, if data is used for Burkina Faso in 2020 and 2019, this column can help distinguish the indicators.
WSC_AP	data.frame with the general WSC analysis plan (AP) than can be found here or as an object in the package (WSC::WSC_AP)
WIS_water	data.frame with the scoring reference matrix for the Water component of the WASH Insecurity Score (WIS)
WIS_sanitation	data.frame with the scoring reference matrix for the Sanitation component of the WIS
WIS_final	data.frame with the scoring reference matrix for the final score of the WIS

Value

a dataframe containing the results of the scoring for each household in the dataset. NAs are introduced if variables cannot be found or score calculated.

Examples

score_WIS(data = WSC::bfa_msna_2020, context_AP = WSC::context_AP, context = "bfa_2020",
         WSC_AP = WSC::WSC_AP, WIS_water = WSC::WIS_water, WIS_sanitation = WSC::WIS_sanitation,
         WIS_final = WSC::WIS_final)

ElliottMess/WSC documentation built on Jan. 8, 2021, 12:42 a.m.