EotCycle

EotCycle() calculates a single EOT and is controlled by the main eot() function

Empirical orthogonal teleconnections in R.
'remote' is short for 'R(-based) EMpirical Orthogonal TEleconnections'.
It implements a collection of functions to facilitate empirical
orthogonal teleconnection analysis. Empirical Orthogonal Teleconnections
(EOTs) denote a regression based approach to decompose spatio-temporal
fields into a set of independent orthogonal patterns. They are quite
similar to Empirical Orthogonal Functions (EOFs) with EOTs producing
less abstract results. In contrast to EOFs, which are orthogonal in both
space and time, EOT analysis produces patterns that are orthogonal in
either space or time.

Tim Appelhans

remote

Empirical Orthogonal Teleconnections in R

Florian Detsch

Thomas Nauss

EotCycle function

<dl><dt>x</dt>
<dd>a ratser stack used as predictor</dd>
<dt>y</dt>
<dd>a RasterStack used as response. If <code>y</code> is <code>NULL</code>,
<code>x</code> is used as <code>y</code></dd>
<dt>n</dt>
<dd>the number of EOT modes to calculate</dd>
<dt>standardised</dt>
<dd>logical. If <code>FALSE</code> the calculated r-squared values
will be multiplied by the variance</dd>
<dt>orig.var</dt>
<dd>original variance of the response domain</dd>
<dt>write.out</dt>
<dd>logical. If <code>TRUE</code> results will be written to disk
using <code>path.out</code></dd>
<dt>path.out</dt>
<dd>the file path for writing results if <code>write.out</code> is <code>TRUE</code>.
Defaults to current working directory</dd>
<dt>prefix</dt>
<dd>optional prefix to be used for naming of results if
<code>write.out</code> is <code>TRUE</code></dd>
<dt>type</dt>
<dd>the type of the link function. Defaults to <code>'rsq'</code> as in original
proposed method from <cite>Dool2000</cite>. If set to <code>'ioa'</code> index of agreement is
used instead</dd>
<dt>verbose</dt>
<dd>logical. If <code>TRUE</code> some details about the
calculation process will be output to the console</dd>
<dt>...</dt>
<dd>If <code>write.out = TRUE</code>, further arguments passed to
<code>writeEot()</code>.</dd></dl>

Arguments

Calculate a single EOT — EotCycle

<dl>

<dt>x</dt>
<dd>a ratser stack used as predictor</dd>


<dt>y</dt>
<dd>a RasterStack used as response. If <code>y</code> is <code>NULL</code>,
<code>x</code> is used as <code>y</code></dd>


<dt>n</dt>
<dd>the number of EOT modes to calculate</dd>


<dt>standardised</dt>
<dd>logical. If <code>FALSE</code> the calculated r-squared values
will be multiplied by the variance</dd>


<dt>orig.var</dt>
<dd>original variance of the response domain</dd>


<dt>write.out</dt>
<dd>logical. If <code>TRUE</code> results will be written to disk
using <code>path.out</code></dd>


<dt>path.out</dt>
<dd>the file path for writing results if <code>write.out</code> is <code>TRUE</code>.
Defaults to current working directory</dd>


<dt>prefix</dt>
<dd>optional prefix to be used for naming of results if
<code>write.out</code> is <code>TRUE</code></dd>


<dt>type</dt>
<dd>the type of the link function. Defaults to <code>'rsq'</code> as in original
proposed method from <cite>Dool2000</cite>. If set to <code>'ioa'</code> index of agreement is
used instead</dd>


<dt>verbose</dt>
<dd>logical. If <code>TRUE</code> some details about the
calculation process will be output to the console</dd>


<dt>...</dt>
<dd>If <code>write.out = TRUE</code>, further arguments passed to
<code>writeEot()</code>.</dd>

</dl>

EotCycle: Calculate a single EOT

Description

Usage

Arguments