R/render_temporal_chart.R

In sfisher4/gevitR: minCombinR: Minimal specification syntax for static charts and combinations in R

#Helper functions for temporal chart types
#TODO: convert to uniform input (data, x, y)

#Streamgraph
#Note: Can make using ggplot's geom_area but I don't like the look.
#TODO: Have a conversation about this chart... streamgraph is not on cran yet, which might affect our package getting onto cran
render_streamgraph_old <- function(data, key, value, date) {
  # data <- dplyr::rename(data, key = key, value = value, date = date)
  stream_chart <- streamgraph::streamgraph(data = data, key = key, value = value, date = date, interactive = FALSE)
  stream_chart
}

#' Render Timeline
#'
#' @param ...
#'
#' @return
render_timeline<-function(...){

  spec_list<-list(...)

  #put the specification variables in a location environment
  #so they can be accessed without using a list
  list2env(spec_list,env=environment())

  #right now, expect that this comes form metadata
  date_tmp<-data

  start<-if(is.na(start) & !is.na(x)) x else start

  aes_val<-aes_string(x = start, y = y)


  #check if start and (if applicable) end dates are actually dates
  #--- TO DO : Very loose, makes too many assumptions. Attend to more closely ---
  if(!class(date_tmp[,start]) %in% c("Date")){
    warning("Start date is not a date class. Will try to automatically convert it - unintended side effects may occur.")
    date_tmp[,start]<-as.Date(date_tmp[,start])
  }

  if(!is.na(end)){
    aes_val<-aes_string(x = start, y = y , xend = end,yend = y)
    if(!(class(date_tmp[,end]) %in% c("Date"))){
      warning("End date is not a date class. Will try to automatically convert it - unintended side effects may occur.")
      date_tmp[,end]<-as.Date(date_tmp[,end])
    }
  }

  #if the user has defined color
  if(!is.na(color)){
    aes_val<-aes_val + aes_string(color = color)
  }

  gg_chart<-NULL

  if(is.na(end)){
    gg_chart<- ggplot(data=date_tmp)+
      geom_point(aes_val)+
      theme_bw()#+
      #theme(axis.text.y = element_blank())
  }else{
    #assumes there is only one point defined per item (start or end)
    df_point<-date_tmp %>% dplyr::filter(is.na(!!sym(end)) | is.na(!!sym(end)))

    #assumes everything has a starting point and that some or all items have and endpoint
    df_range<-dplyr::filter(date_tmp,!is.na(!!sym(end)))

    gg_chart<- ggplot()+
      geom_point(data = df_point,aes_val)+
      geom_segment(data = df_range,aes_val)+
      theme_bw()#+
      #theme(axis.text.y = element_blank())
  }

  if(!is.na(y) && class(data[,y]) %in% c("character","factor")){
    if(length(unique(data[,y])) > 50){
      rm_y_labels<-TRUE
    }
  }

  gg_chart<-common_stats_aesethetics(gg_chart,
                                     title=title,
                                     flip_coord = flip_coord,
                                     y_limits = y_limits,
                                     x_limits=x_limits,
                                     x_labels = x_labels,
                                     y_labels = y_labels,
                                     rm_x_labels = rm_x_labels,
                                     rm_y_labels = rm_y_labels,
                                     shrink_plot_margin = shrink_plot_margin)
  return(gg_chart)
}