R/bind_fcst.R

In andrew-MET/harpIO: IO functions and data wrangling for harp

#' Bind deterministic forecasts into a single data frame
#'
#' `r lifecycle::badge("deprecated")`
#' This function was deprecated due to class definition changes. Use
#' \code{\link[harpCore]{bind}} instead.
#'
#' Given a harp_fcst list, \code{bind_fcst} binds the data frames in the
#' harp_fcst list into a single data frame for easy plotting. For ensemble
#' forecasts, the member data are gathered into a single column.
#'
#' @param .fcst A harp_fcst list
#'
#' @return A data frame
#' @export
#'
bind_fcst <- function(.fcst) {

  lifecycle::deprecate_stop(
    "0.1.0",
    "bind_fcst()",
    "bind()"
  )
  stopifnot(is.list(.fcst))
  stopifnot(!is.null(names(.fcst)))
  stopifnot(inherits(.fcst, "harp_fcst"))

  rename_func <- function(list_name) {
    if (any(grepl("_det$", colnames(.fcst[[list_name]])))) {
      fcst_col <- rlang::sym(paste0(list_name, "_det"))
      .fcst[[list_name]] <- dplyr::rename(
        .fcst[[list_name]],
        forecast = !! fcst_col
      )
    } else {
      .fcst <- harpCore::pivot_members(.fcst)
    }
    .fcst[[list_name]] <- dplyr::mutate(.fcst[[list_name]], mname = list_name) %>%
      dplyr::select(.data$mname, dplyr::everything())
  }

  fcst_names <- names(.fcst)
  dplyr::bind_rows(lapply(fcst_names, rename_func))
}