R/esm_ts.R

In gertstulp/ESMvis: Visualising Experience Sampling Method Data

# library(ggplot2)

#' Wrapper function to create timeseries line plot.
#'
#' @param data A dataframe.
#' @param var_date A string with the name of the date-variable for the x-axis.
#' @param vars_event LALALALALA.
#' @param lines A string with name of variable specifying the different groups which will be represented as different lines.
#' @param outcome A string with name of variable specifying the outcome.
#' @param vis_options A list with options for the graph.
#' The possibilities for the vis_options are:
#' "line = TRUE/FALSE"; whether or not a line should be drawn
#' "point = TRUE/FALSE"; whether or not points/dots should be drawn
#' "smooth = TRUE/FALSE"; whether or not smoothening line should be drawn.
#' "kernel = ..."; parameter to control the degree of smoothening (between 0 and 1).
#' "se_band = TRUE/FALSE"; whether or not confidence band should be drawn around smoothening line.
#' "axis_limits = ..."; vector with lower and upper limit of y-axis (e.g., c(0, 10))
#' @return A ggplot-object/graph.
#' @import ggplot2
#' @importFrom dplyr mutate lead select unique
#' @import animation

#' @export
esm_ts <- function(data = NULL,
                   var_date = NULL,
                   vars_event = NULL,
                   lines = NULL,
                   outcome = NULL,
                   vis_options = NULL)
{

  plot <- ggplot(data,
                 aes_string(x = var_date, y = outcome, colour = lines)) +
    theme_minimal() +
    labs(x = "Time", colour = NULL)

  if ( length(vars_event) != 0 ) {

    # FIX THIS CODE WITHOUT USING THE PIPE
    # ALSO FIX THE ARRANGE_ ISSUE QUOSURES AAAHHHH

    event_df <- data %>%
      select(c(var_date, vars_event[["score_event"]],
               vars_event[["text_event"]])) %>%
      unique()  %>%
      arrange_(var_date) %>% # CHECK QUOSURE as.name !! AAAAGGGUUUHHHH
      mutate(var_date_next = lead(date_esmvis))

    #print(slice(event_df, (nrow(event_df)-10):nrow(event_df)))

    plot <- plot + geom_rect(data = event_df,
                             aes(xmin = get(var_date),
                                 xmax = var_date_next,
                                 ymin = -Inf,
                                 ymax = Inf,
                                 fill = get(vars_event[["score_event"]])),
                             inherit.aes = FALSE, alpha = 0.5) +
      scale_fill_gradient2(low = "red",
                           high = "blue", midpoint = 0, na.value = "white") +
      guides(fill = guide_legend(override.aes = list(alpha = 0.5))) +
      #guides(fill = guide_colourbar(override.aes = list(alpha = 0.5))) +
      labs(fill = "Experience")
  }

  # DIT KAN VEEL EFFICIENTER!!!
  if ( length(vis_options) == 0 ) {
    plot <- plot + geom_smooth(se = FALSE, kernel = 0.25)
  } else if ( length(vis_options) != 0 ) {
    if ( !is.null(vis_options[["line"]]) && vis_options[["line"]] == TRUE ) {
      plot <- plot + geom_line()
    }
    if ( !is.null(vis_options[["point"]]) && vis_options[["point"]] == TRUE ) {
      plot <- plot + geom_point()
    }
    if ( !is.null(vis_options[["smooth"]]) &&
         vis_options[["smooth"]] == TRUE)  {
      if (is.null(vis_options[["kernel"]]) &&
          is.null(vis_options[["se_band"]]) ) {
        plot <- plot + geom_smooth()
      }
      if (!is.null(vis_options[["kernel"]]) &&
          !is.null(vis_options[["se_band"]]) ) {
        plot <- plot + geom_smooth(span = vis_options[["kernel"]],
                                   se = vis_options[["se_band"]])
      } else if (!is.null(vis_options[["kernel"]]) ) {
        plot <- plot + geom_smooth(span = vis_options[["kernel"]])
      } else if (!is.null(vis_options[["se_band"]]) ) {
        plot <- plot + geom_smooth(se = vis_options[["se_band"]])
      }
    }
    if ( !is.null(vis_options[["axis_limits"]]) ) {
      plot <- plot +
        coord_cartesian(ylim = vis_options[["axis_limits"]])
    }
  }

  plot
} # CAN BE DONE WITH &labs