summaryPOP2var: Summary of a variable in a POP2 simulation

Description Usage Arguments Details Value

View source: R/summaryPOP2var.R

Description

Get the maximum and minimum of a POP2 grid as well as the coresponding array indexes and geographical coordiantes, plus the global standard deviation and mean value

Usage

1
  summaryPOP2var(x, long, latg, zg, mask=NULL, z2Did=1)

Arguments

x

REAL [nlon,nlat,nz || 1] grid

long

REAL [nlon,nlat], longitude grid

latg

REAL [nlon,nlat], latitude grid

zg

REAL [nz], depth grid in [cm]

mask

LOGICAL [nlon,nlat,nz || 1] grid, matching the dimensions of x. NULL for no masking

z2Did

INTEGER, indicating the index within the depth grid zg, when the input grid x is a 2D layer. Defaults to 1, so that for surface layers the returned geographical depth coordinate will be that of the uppermost layer in the depth grid, even if the variable refers to an ocean top surface variable [e.g. the skin layer]

Details

The mean value provided in this function is the direct mean for the, possibly masked, grid values. A weighted mean that condisers the volumne of each model cell is provided by ocnWmean.

Value

A matrix with a global summmary of a POP2 variable.


garciapintado/rdafCESM documentation built on July 18, 2019, 4:41 p.m.