R/barchart_sums.R

In USGS-R/wateRuse: wateRuse data analysis functions

#' barchart_sums
#'
#' barchart_sums
#' 
#' @param data.elements character name of data element within available categories by year for state
#' @param years vector of integers specifying range of years to graph. Defaults to NA which shows all years in dataset.
#' @param w.use is a subset of the datafile wUseSample that includes all areas in all data elements for state
#' @param areas is a geographical area as defined in your datafile such as county, HUC, or aquifer
#' @param area.column character that defines which column to use to specify area
#' @param y.scale allows R to set the y-axis scale given available data range. Defaults to NA which lets R set the scale based on dataset values.
#' @param plot.stack is a logical function to show graph as optionally stacked or clustered bar graph
#' @param c.palette color palette to use for fill
#'
#' 
#' @export
#' @import ggplot2
#' @importFrom tidyr gather_
#' @importFrom grDevices colorRampPalette
#' 
#' @examples 
#' w.use <- wUseSample
#' areas <- c("New Castle County", "Kent County")
#' area.column = "COUNTYNAME"
#' data.elements <- c("PS.WTotl","CO.WTotl","DO.WTotl","IN.WTotl","PF.WTotl")
#' barchart_sums(w.use, data.elements, area.column = area.column,areas = areas)
#' barchart_sums(w.use, data.elements, plot.stack = FALSE,
#'        area.column = area.column,areas = areas)
#' barchart_sums(w.use, data.elements, area.column)
#' barchart_sums(w.use, data.elements, area.column, y.scale = c(0,500))
#' barchart_sums(w.use, data.elements, area.column, 
#'        y.scale = c(0,100), years = c(1990,2005))
barchart_sums <- function(w.use, data.elements, area.column, plot.stack=TRUE,
                          years=NA, areas=NA, y.scale=NA,
                          c.palette = c("#999999", "#E69F00", "#56B4E9", "#009E73", "#F0E442", "#0072B2", "#D55E00", "#CC79A7")){
  
  w.use.sub <- subset_wuse(w.use, data.elements, area.column, areas)

  if(!any(is.na(years))){
    w.use.sub <-  w.use.sub[w.use.sub$YEAR %in% years,]
    w.use.sub$YEAR <- as.factor(w.use.sub$YEAR)
    levels(w.use.sub$YEAR) <- as.character(years)
  }
  
  df2 <- w.use.sub[,c("YEAR",area.column,data.elements)]
  
  df3 <- gather_(df2, "dataElement", "value", c(data.elements))
  
  bc.object <- ggplot(data = df3) 
  
  if(plot.stack){
    bc.object <- bc.object + geom_bar(aes_string(x = "YEAR", y = "value", 
                                                 fill = "dataElement"), 
                                      position = "stack",stat="identity")
  } else {
    bc.object <- bc.object + geom_bar(aes_string(x = "YEAR", y = "value", fill = "dataElement"), 
                                      position = "dodge",stat="identity")
  }

  colorList <- c("PS.WTotl",
    "DO.WTotl",
    "IN.WTotl", 
    "PT.WTotl", 
    "MI.WTotl", 
    "LS.WTotl", 
    "AQ.WTotl",
    "IT.WTotl",
    "TP.TotPop",
    "TO.WGWTo", 
    "TO.WSWTo")
  #facet if totals available for multiple areas (counties, etc)
  if(all(data.elements %in% colorList)){
    bc.object <- bc.object + 
      scale_fill_manual(values =   c("PS.WTotl" = "mediumpurple4",
                                     "DO.WTotl" = "maroon3",
                                     "IN.WTotl" = "burlywood4", 
                                     "PT.WTotl" = "darkgoldenrod2", 
                                     "MI.WTotl" = "darkorange2", 
                                     "LS.WTotl" = "firebrick2", 
                                     "AQ.WTotl" = "steelblue",
                                     "IT.WTotl" = "darkcyan",
                                     "TP.TotPop" = "steelblue2",
                                     "TO.WGWTo" = "purple", 
                                     "TO.WSWTo" = "brown"))
  }

  bc.object <- bc.object +
    facet_grid(as.formula(paste0(area.column," ~ .")), scales="free") +
    ylab("") 
  
  if(!all(is.na(y.scale))){
    bc.object <- bc.object + ylim(y.scale)
  }
  
  bc.object
  
  return(bc.object)
}