R/wrapper.R

In Jack-H-Laverick/slabR: Summarise Slabs from Arrays in R

#### Functions to average volumes once extracted ####

#' Prepare for Averaging by Decade
#'
#' This function cleans the saved NEMO-MEDUSA monthly summaries, for averaging into decades.
#'
#' @param array A dataframe containing a summarised month from NEMO-MEDUSA model outputs.
#' @param scheme A dataframe containing a summarised month from NEMO-MEDUSA model outputs.
#' @param fun A dataframe containing a summarised month from NEMO-MEDUSA model outputs.
#' @return A dataframe containing a summarised month of NEMO-MEDUSA output, gaining a decade column, and dropping columns
#' which aren't needed for spatial maps.
#' @family NEMO-MEDUSA averages
#' @export
slab <- function(array, scheme, fun = "weighted mean") {

# Check a supported summary function was selected
if(!fun %in% c("weighted mean")) stop(paste0("summary operation '", fun, "' not supported. Choose from 'mean' or 'weighted mean'"))  

# Apply the summary function by slab  
if(fun == "weighted mean") summary <- array_w_mean(array, scheme)

  return(summary)
}