expandpca: expandpca

View source: R/expandpca.R

expandpcaR Documentation

expandpca

Description

The function expandpca is used to extract information from PCA-based dsensemble-objects, but takes care of extra house keeping, such as attributes with meta data. It applies operations onto the PCs through the argument 'FUNX' to estimate quantities such as the ensemble mean. The argument 'FUN' is used to aggregate the results from e.g. the ensemble mean to provide maps of means or trends. Hence these functions are used to expand PCA to obtain station data or EOFs into field data. aggregate.dsensemble is used for aggregating ensembles in a similar fashion, but is slower and applies the operation onto the data after it has been expanded by matrix multiplication of the singular vectors (X = U map.dsensemble is a wrapper for map that uses expandpca or aggregate.dsensemble to distill selected information.

Usage

expandpca(
  x,
  it = NULL,
  FUN = NULL,
  FUNX = "mean",
  verbose = FALSE,
  anomaly = FALSE,
  test = FALSE,
  eof = TRUE
)

Arguments

x

an object of type 'pca'

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

test

if TRUE perform test on one GCM simulation

See Also

aggregate map.dsensemble aggregate.dsensemble


metno/esd documentation built on April 29, 2024, 3:34 p.m.