R/plot_data_overview.R

In KWB-R/kwb.flusshygiene: Functions used within FLUSSHYGIENE project (BMBF)

# plot_data_overview -----------------------------------------------------------
#'
#' Plot Data Timeline Overview
#'
#' Creates a plot with segments or points of the data availability.
#'
#' @param riverdata A list of hygiene and physical data of the river
#' @param type Either "segment" or "point" for more precise information
#'
#' @return Returns a plot
#'
#' @export
#' @importFrom dplyr bind_rows select contains group_by summarise
#' @import ggplot2
#' @importFrom tidyr gather
#' @importFrom lubridate as_date
#'

plot_data_overview <- function (riverdata, type = "segment")
{
  stopifnot(type == "segment" || type == "point")

  overview <- dplyr::bind_rows(.id = "Typ", lapply(riverdata, function(df) {

    df <- dplyr::select(df, - dplyr::contains("max"))

    df2 <- stats::na.omit(tidyr::gather(df, "site", "n", -1))

    df2 <- dplyr::group_by(df2, .data$site)

    if (type == "point") {

      return(df2)
    }

    date_range <- range(df2$datum)

    return(dplyr::summarise(df2, start = date_range[1], end = date_range[2]))

  }))

  p <- ggplot2::ggplot(
    overview, ggplot2::aes_string(y = "site", color = "Typ")
  ) +
    ggplot2::theme(
      axis.text.x = ggplot2::element_text(angle = 60, hjust = 1),
      text = ggplot2::element_text(size = 15)
    ) +
    ggplot2::labs(
      title = "Datenverf\u00fcgbarkeit", x = "Zeitraum",
      y = "Variable und Standort"
    ) +
    ggplot2::scale_x_date(date_breaks = "1 years", date_labels = "%Y") +
    ggplot2::scale_y_discrete(limits = rev(levels(factor(overview$site))))

  if (type == "segment") {

    p$data$start <- lubridate::as_date(p$data$start)
    p$data$end <- lubridate::as_date(p$data$end)

    p + ggplot2::geom_segment(
      size = 4, ggplot2::aes_string(x = "start", xend = "end", yend = "site")
    )

  } else {

    p$data$datum <- lubridate::as_date(p$data$datum)

    p + ggplot2::geom_point(
      size = 2, alpha = 0.5, ggplot2::aes_string(x = "datum")
    )
  }
}