NM_volume_summary: Summarise NEMO-MEDUSA Output into Time Series Within Model...

View source: R/NM functions.R

NM_volume_summaryR Documentation

Summarise NEMO-MEDUSA Output into Time Series Within Model Compartments This function averages NEMO-MEDUSA monthly summaries into time series for each model compartment.

Description

The function groups by model compartment (Depth and Shore zone) and time step (Month and Year). The mean for every target variable is calculated within these groups.

Usage

NM_volume_summary(saved, ice_threshold = 0, ice = TRUE)

Arguments

saved

A dataframe containing a summarised month from NEMO-MEDUSA model outputs.

ice_threshold

A value between 0 and 1 defining ice free pixels.

ice

A TRUE FALSE switch for whether the ice_mod files were included when extracting from NEMO-MEDUSA.

Details

The ice-threshold parameter controls how high the concentration of ice must be at a pixel to count as ice-affected. The default is set to 0, so any pixels with ice are counted, but if you decide that ice-concentrations below 0.05 are meaningless for your purposes, you can set the threshold to have these pixels classed as ice free instead. This will also drop the pixels from calculations of Ice_concentration, Ice_Thickness, and Snow_Thickness.

Value

A dataframe containing a mean monthly time series of all target variables in NEMO-MEDUSA outputs.

See Also

Other NEMO-MEDUSA averages: NM_boundary_summary(), NM_decadal_summary(), decadal(), strip_ice()


Jack-H-Laverick/MiMeMo.tools documentation built on March 6, 2023, 3:44 p.m.