R/regionalJointFits.r

In w-hardy/serCymruTools: Tools For Analysing GP Prescribing Data

#' @title Forecasts for each regional unit
#'
#' @description Various fable and prophet forecasts for monthly quantity for each regional_unit. Will take advantage of plan() if called outside of function.
#'
#' @param data A dataframe with time as `datename` and quantity as `n`.
#'
#' @import dplyr
#' @import furrr
#' @import future
#'
#' @return Dataframe of model fits
#' @export
#'
#' @examples
#' \dontrun{regionalJointFcsts(data)}
#'
regionalJointFits <-
  function(data){
    regions <- unique(data$regional_unit)

    fable_fit <-
      future_map_dfr(.x = regions,
                     .f = ~fableModels(filter(data, regional_unit == .x)),
                     .options = furrr_options(seed = TRUE))
    message("fable fits complete")

    return(fable_fit)
  }