aggregate.dsensemble: aggregate.dsensemble

View source: R/aggregate.dsensemble.R

aggregate.dsensembleR Documentation

aggregate.dsensemble

Description

The function aggregate.dsensemble is used to extract and aggregate information from PCA-based dsensemble-objects, to expand PCA into station data or EOFs into field data. It applies operations through the argument 'FUNX' to estimate quantities such as the ensemble mean and takes care of extra house keeping, such as attributes with meta data. aggregate.dsensemble is similar to expandpca but applies 'FUNX' for each time step after it has been expanded by matrix multiplication of the singular vectors (X = U map.dsensemble is a wrapper for map that uses one of the two former routines to distill selected information.

Usage

## S3 method for class 'dsensemble'
aggregate(
  x,
  ...,
  it = NULL,
  im = NULL,
  FUN = NULL,
  FUNX = "mean",
  verbose = FALSE,
  anomaly = FALSE,
  qc = TRUE,
  test = FALSE,
  eof = TRUE
)

Arguments

x

an object of type 'dsensemble'

it

time index (see subset)

FUN

function applied to aggregate in time

FUNX

function applied aggregate ensemble members

verbose

if TRUE print progress

anomaly

if FALSE add the mean value stored as attribute in x

qc

if TRUE perform quality control and exclude ensemble members with incomplete or suspect data

test

if TRUE perform test on one GCM simulation

eof

if TRUE and if the dsensemble object contains a spatially aggregated pattern, x$eof, expand with x$eof into an ensemble of field objects to which FUNX is applied. If FALSE, expand using the original pattern x$pca into an ensemble of station objects to be aggregated.

See Also

aggregate expandpca map.dsensemble


metno/esd documentation built on April 24, 2024, 9:19 p.m.