R/overall.R

In validmeasures/wsup: An Implementation of the WSUP Urban Water and Sanitation Survey in R

################################################################################
#
#' Calculate overall indicators
#'
#' @param adminDF A data frame containing administrative information variables
#' @param waterDF A data frame containing calculated water indicators
#' @param sanDF A data frame containing calculated sanitation indicators
#' @return A data frame of calculated overall indicators
#' @examples
#' # Apply get_overall_vars() to surveyDataBGD dataset
#' 
#' admin <- get_admin_vars(washdata::surveyDataBGD)
#' water <- get_water_vars(washdata::surveyDataBGD)
#' sanitation <- get_sanitation_vars(washdata::surveyDataBGD)
#' 
#' overallDF <- get_overall_vars(adminDF = admin, waterDF = water, sanDF = sanitation)
#' 
#' @export
#'  
# 
################################################################################

get_overall_vars <- function(adminDF, waterDF, sanDF) {
  ## overall1: not adequate water and not adequate sanitaiton services
  overall1 <- ifelse(waterDF$accessWater == 0 & sanDF$adequateSan == 0, 1, 0)
  ## overall2: adequate water only
  overall2 <- ifelse(waterDF$accessWater == 1 & sanDF$adequateSan == 0, 1, 0)
  ## overall3: adequate sanitation only
  overall3 <- ifelse(waterDF$accessWater == 0 & sanDF$adequateSan == 1, 1, 0)
  ## overall4: adequate water and adequate sanitation services
  overall4 <- ifelse(waterDF$accessWater == 1 & sanDF$adequateSan == 1, 1, 0)
  ## Overall spend
  overallSpend <- rowSums(data.frame(waterDF$water12, sanDF$san14, sanDF$san34a), na.rm = TRUE)
  ## Create overallDF
  ## Concatenate overall indicators
  overallDF <- data.frame("uniqueID" = adminDF[ , "uniqueID"],
                          overall1, overall2, overall3, overall4, overallSpend)
  ## Return output
  return(overallDF)
}