R/createDailyMeanComparePlot.R

In CfSOtago/gridCarbon: Code to analyse the carbon footprint of NZ electricity generation over time

#' Creates a daily half-hourly mean plot from the data.table given
#'
#' `createDailyMeanComparePlot` returns a plot which calculates the mean of yVar and plots it for 2020 and 2017-2019 to 
#' compare the values for the same date over previous years. This assumes users pass in the aligned-date data (`dateFixed`). 
#'
#' Adds a smoothed line using loess.
#' 
#' @param dt the data, assumed to be the aligned data (use alignDates() to do this)
#' @param yVar the variable you want to plot
#' @param yCap the caption for the y axis
#' @param form do you want a "line" = geom_line() or a "step" = geom_step()? Step is the default
#' @param yDiv the value you want to divide yVar by to make the y axis more sensible. Default = 1
#' @param lockDownStart date for start of lockdown rectangle annotation
#' @param lockDownEnd date for end of lockdown rectangle annotation
#' @param comparePlotCut start date to cut the plot (default 2020-01-01)
#' @param toDate date to end the plot (usually the most recent observation), default = today()
#' 
#' @import lubridate
#' @import data.table
#' @author Ben Anderson, \email{b.anderson@@soton.ac.uk}
#' @export
#' @family plot
#'
createDailyMeanComparePlot <- function(dt, yVar, yCap, form = "step", yDiv = 1, 
                                       lockDownStart, lockDownEnd, 
                                       comparePlotCut = as.Date("2020-01-01"),
                                       toDate = lubridate::today()){
  message("lockDownStart: ", lockDownStart)
  message("lockDownEnd: ", lockDownEnd)
  message("toDate: ", toDate)
  # assumes the dateFixed half-hourly data
  # assumes we want mean of half-hourly obs
  plotDT <- dt[dateFixed >= comparePlotCut & dateFixed <= lubridate::as_date(toDate), # otherwise we get the whole year 
               .(yMean = mean(get(yVar))/yDiv, # do this here so min/max work
                 nObs = .N
               ),
               keyby = .(dateFixed, wkdayFixed, weekDay, compareYear)]
  
  # make plot - adds annotations
  yMin <- min(plotDT$yMean)
  yMax <- max(plotDT$yMean)
  
  p <- ggplot2::ggplot(plotDT, aes(x = dateFixed, 
                                   y = yMean,
                                   shape = weekDay,
                                   colour = compareYear)) +
    geom_point() +
    scale_x_date(date_breaks = "7 day", date_labels =  "%a %d %b")  +
    theme(axis.text.x=element_text(angle=90, hjust=1)) +
    labs(x = "Date",
         y = yCap
    ) +
    theme(legend.position = "bottom") + 
    geom_smooth(aes(shape = NULL), method = "loess") + # will get a smooth line per year not per day, force loess not gam
    scale_color_discrete(name = "Period") +
    scale_shape_discrete(name = "Weekday") +
    guides(colour=guide_legend(nrow=2)) +
    guides(shape=guide_legend(nrow=2))
  if(form == "line"){
    p <- p + geom_line(aes(shape = NULL), 
                       linetype = "dashed") # join the dots within compareYear
  }
  if(form == "step"){
    p <- p + geom_step(aes(shape = NULL), 
                       linetype = "dashed") # join the dots within compareYear
  }
  p <- addLockdownRect(p, 
                       from = lockDownStart, 
                       to = lockDownEnd,
                       yMin = yMin, 
                       yMax = yMax)
  
  p <- addWeekendRectsDate(p, 
                           yMin, 
                           yMax)
  return(p)
}