R/admin.R

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

################################################################################
#
#' Get administrative information variables from survey data and create
#' a data frame of administrative indicators
#' 
#' @param data Survey data frame
#' @param vars Vector of variable names for administrative information. Default
#'     is c("country", "ccode", "uniqueID", "psu", "zone", "type", "quadrat",
#'     "hhid", "month", "year", "longitude", "latitude")
#'     
#' @return A data frame object of administrative information variables
#'     
#' @examples
#' # Create adminDF using Dhaka survey data     
#' get_admin_vars(data = washdata::surveyDataBGD)
#'
#' @export
#'
#
################################################################################

get_admin_vars <- function(data, 
                           vars = c("country", "ccode", "uniqueID", "psu", "zone", 
                                    "type", "quadrat", "hhid", "month", "year", 
                                    "longitude", "latitude")) {
  ##
  adminDF <- data[ , vars]
  ## Return output
  return(adminDF)
}


################################################################################
#
#' Get demographic information variables from survey data and create a
#' data frame object of demographic indicators
#'
#' @param data Survey data frame
#' @param vars Vector of variable names for demographic information. Default is
#'     c("uniqueID", "gender", "landOwnStatus", "nWomen", "nMen", "nOldWomen", 
#'     "nOldMen", "nGirls", "nBoys", "nInfants", "nMobility")
#' 
#' @examples
#' # Create demoDF using Dhaka survey data
#' get_demo_vars(data = washdata::surveyDataBGD)
#'
#' @export
#
################################################################################

get_demo_vars <- function(data,
                          vars = c("uniqueID", "gender", "landOwnStatus",
                                   "nWomen", "nMen", "nOldWomen", "nOldMen",
                                   "nGirls", "nBoys", "nInfants", "nMobility")) {
  ##
  demoDF <- data[ , vars]
  ## Count total number of household members
  nMembers <- data$nWomen + data$nMen + 
    data$nOldMen + data$nOldWomen + 
    data$nGirls + data$nBoys + 
    data$nInfants  
  ## Create demographic data.frame
  demoDF <- data.frame(demoDF, nMembers)
  ## Return output
  return(demoDF)
}