Commit fe00469e authored by aho's avatar aho
Browse files

Merge branch 'develop-doc_fix' into 'master'

Update and fix indices documentation

See merge request !54
parents f26dbac6 42f03000
Pipeline #5391 passed with stage
in 2 minutes and 53 seconds
......@@ -12,7 +12,7 @@
#' (in case of historical simulations or observations). This data has to be
#' provided, at least, over the whole region needed to compute the index.
#' The dimensions must be identical to thos of data_tos.
#' #'@param data_tos A numerical array with the sea surface temperature data
#'@param data_tos A numerical array with the sea surface temperature data
#' to be used for the index computation with, at least, the
#' dimensions: 1) latitude, longitude, start date and forecast month
#' (in case of decadal predictions), 2) latitude, longitude, year and month
......
......@@ -18,16 +18,15 @@ AMV(
indices_for_clim = NULL,
year_dim = "year",
month_dim = "month",
member_dim = "member",
na.rm = TRUE,
ncores = NULL
)
}
\arguments{
\item{data}{A numerical array to be used for the index computation with the
dimensions: 1) latitude, longitude, start date, forecast month, and member
(in case of decadal predictions), 2) latitude, longitude, year, month and
member (in case of historical simulations), or 3) latitude, longitude, year
and month (in case of observations or reanalyses). This data has to be
\item{data}{A numerical array to be used for the index computation with, at least, the
dimensions: 1) latitude, longitude, start date and forecast month
(in case of decadal predictions), 2) latitude, longitude, year and month
(in case of historical simulations or observations). This data has to be
provided, at least, over the whole region needed to compute the index.}
\item{data_lats}{A numeric vector indicating the latitudes of the data.}
......@@ -70,7 +69,7 @@ climatology is calculated over the whole period. If the data are already
anomalies, set it to FALSE. The default value is NULL.\cr
In case of parameter 'type' is 'dcpp', 'indices_for_clim' must be relative
to the first forecast year, and the climatology is automatically computed
over the actual common period for the different forecast years.}
over the common calendar period for the different forecast years.}
\item{year_dim}{A character string indicating the name of the year dimension
The default value is 'year'. Only used if parameter 'type' is 'hist' or
......@@ -80,18 +79,17 @@ The default value is 'year'. Only used if parameter 'type' is 'hist' or
dimension. The default value is 'month'. Only used if parameter 'type' is
'hist' or 'obs'.}
\item{member_dim}{A character string indicating the name of the member
dimension. The default value is 'member'. Only used if parameter 'type' is
'dcpp' or 'hist'.}
\item{na.rm}{A logical value indicanting whether to remove NA values. The default
value is TRUE.}
\item{ncores}{An integer indicating the number of cores to use for parallel
computation. The default value is NULL.}
}
\value{
A numerical array of the AMV index with the dimensions of:
1) sdate, forecast year, and member (in case of decadal predictions);
2) year and member (in case of historical simulations); or
3) year (in case of observations or reanalyses).
A numerical array with the AMV index with the same dimensions as data except
the lat_dim, lon_dim and fmonth_dim (month_dim) in case of decadal predictions
(historical simulations or observations). In case of decadal predictions, a new dimension
'fyear' is added.
}
\description{
The Atlantic Multidecadal Variability (AMV), also known as Atlantic
......@@ -100,7 +98,8 @@ surface temperatures (SST) over the North Atlantic Ocean on multi-decadal
time scales. The AMV index is computed as the difference of weighted-averaged
SST anomalies over the North Atlantic region (0ºN-60ºN, 280ºE-360ºE) and the
weighted-averaged SST anomalies over 60ºS-60ºN, 0ºE-360ºE (Trenberth &
Dennis, 2005; Doblas-Reyes et al., 2013).
Dennis, 2005; Doblas-Reyes et al., 2013). If different members and/or datasets are provided,
the climatology (used to calculate the anomalies) is computed individually for all of them.
}
\examples{
## Observations or reanalyses
......
......@@ -21,28 +21,26 @@ GMST(
indices_for_clim = NULL,
year_dim = "year",
month_dim = "month",
member_dim = "member",
na.rm = TRUE,
ncores = NULL
)
}
\arguments{
\item{data_tas}{A numerical array indicating the surface air temperature data
to be used for the index computation with the dimensions: 1) latitude,
longitude, start date, forecast month, and member (in case of decadal
predictions), 2) latitude, longitude, year, month and member (in case of
historical simulations), or 3) latitude, longitude, year and month (in case
of observations or reanalyses). This data has to be provided, at least,
over the whole region needed to compute the index. The dimensions must be
identical to those of data_tos.}
\item{data_tos}{A numerical array indicating the sea surface temperature data
to be used for the index computation with the dimensions: 1) latitude,
longitude, start date, forecast month, and member (in case of decadal
predictions), 2) latitude, longitude, year, month and member (in case of
historical simulations), or 3) latitude, longitude, year and month (in case
of observations or reanalyses). This data has to be provided, at least,
over the whole region needed to compute the index. The dimensions must be
identical to those of data_tas.}
\item{data_tas}{A numerical array with the surface air temperature data
to be used for the index computation with, at least, the
dimensions: 1) latitude, longitude, start date and forecast month
(in case of decadal predictions), 2) latitude, longitude, year and month
(in case of historical simulations or observations). This data has to be
provided, at least, over the whole region needed to compute the index.
The dimensions must be identical to thos of data_tos.}
\item{data_tos}{A numerical array with the sea surface temperature data
to be used for the index computation with, at least, the
dimensions: 1) latitude, longitude, start date and forecast month
(in case of decadal predictions), 2) latitude, longitude, year and month
(in case of historical simulations or observations). This data has to be
provided, at least, over the whole region needed to compute the index.
The dimensions must be identical to thos of data_tas.}
\item{data_lats}{A numeric vector indicating the latitudes of the data.}
......@@ -90,7 +88,7 @@ climatology is calculated over the whole period. If the data are already
anomalies, set it to FALSE. The default value is NULL.\cr
In case of parameter 'type' is 'dcpp', 'indices_for_clim' must be relative
to the first forecast year, and the climatology is automatically computed
over the actual common period for the different forecast years.}
over the common calendar period for the different forecast years.}
\item{year_dim}{A character string indicating the name of the year dimension
The default value is 'year'. Only used if parameter 'type' is 'hist' or
......@@ -100,23 +98,23 @@ The default value is 'year'. Only used if parameter 'type' is 'hist' or
dimension. The default value is 'month'. Only used if parameter 'type' is
'hist' or 'obs'.}
\item{member_dim}{A character string indicating the name of the member
dimension. The default value is 'member'. Only used if parameter 'type' is
'dcpp' or 'hist'.}
\item{na.rm}{A logical value indicanting whether to remove NA values. The default
value is TRUE.}
\item{ncores}{An integer indicating the number of cores to use for parallel
computation. The default value is NULL.}
}
\value{
A numerical array of the GMST anomalies with the dimensions of:
1) sdate, forecast year, and member (in case of decadal predictions);
2) year and member (in case of historical simulations); or
3) year (in case of observations or reanalyses).
A numerical array with the GMST anomalies with the same dimensions as data_tas except
the lat_dim, lon_dim and fmonth_dim (month_dim) in case of decadal predictions
(historical simulations or observations). In case of decadal predictions, a new dimension
'fyear' is added.
}
\description{
The Global Mean Surface Temperature (GMST) anomalies are computed as the
weighted-averaged surface air temperature anomalies over land and sea surface
temperature anomalies over the ocean.
temperature anomalies over the ocean. If different members and/or datasets are provided,
the climatology (used to calculate the anomalies) is computed individually for all of them.
}
\examples{
## Observations or reanalyses
......
......@@ -18,16 +18,15 @@ GSAT(
indices_for_clim = NULL,
year_dim = "year",
month_dim = "month",
member_dim = "member",
na.rm = TRUE,
ncores = NULL
)
}
\arguments{
\item{data}{A numerical array to be used for the index computation with the
dimensions: 1) latitude, longitude, start date, forecast month, and member
(in case of decadal predictions), 2) latitude, longitude, year, month and
member (in case of historical simulations), or 3) latitude, longitude, year
and month (in case of observations or reanalyses). This data has to be
\item{data}{A numerical array to be used for the index computation with, at least, the
dimensions: 1) latitude, longitude, start date and forecast month
(in case of decadal predictions), 2) latitude, longitude, year and month
(in case of historical simulations or observations). This data has to be
provided, at least, over the whole region needed to compute the index.}
\item{data_lats}{A numeric vector indicating the latitudes of the data.}
......@@ -70,7 +69,7 @@ climatology is calculated over the whole period. If the data are already
anomalies, set it to FALSE. The default value is NULL.\cr
In case of parameter 'type' is 'dcpp', 'indices_for_clim' must be relative
to the first forecast year, and the climatology is automatically computed
over the actual common period for the different forecast years.}
over the common calendar period for the different forecast years.}
\item{year_dim}{A character string indicating the name of the year dimension
The default value is 'year'. Only used if parameter 'type' is 'hist' or
......@@ -80,22 +79,23 @@ The default value is 'year'. Only used if parameter 'type' is 'hist' or
dimension. The default value is 'month'. Only used if parameter 'type' is
'hist' or 'obs'.}
\item{member_dim}{A character string indicating the name of the member
dimension. The default value is 'member'. Only used if parameter 'type' is
'dcpp' or 'hist'.}
\item{na.rm}{A logical value indicanting whether to remove NA values. The default
value is TRUE.}
\item{ncores}{An integer indicating the number of cores to use for parallel
computation. The default value is NULL.}
}
\value{
A numerical array of the GSAT anomalies with the dimensions of:
1) sdate, forecast year, and member (in case of decadal predictions);
2) year and member (in case of historical simulations); or
3) year (in case of observations or reanalyses).
A numerical array with the GSAT anomalies with the same dimensions as data except
the lat_dim, lon_dim and fmonth_dim (month_dim) in case of decadal predictions
(historical simulations or observations). In case of decadal predictions, a new dimension
'fyear' is added.
}
\description{
The Global Surface Air Temperature (GSAT) anomalies are computed as the
weighted-averaged surface air temperature anomalies over the global region.
weighted-averaged surface air temperature anomalies over the global region.
If different members and/or datasets are provided, the climatology (used to
calculate the anomalies) is computed individually for all of them.
}
\examples{
## Observations or reanalyses
......
......@@ -18,16 +18,15 @@ SPOD(
indices_for_clim = NULL,
year_dim = "year",
month_dim = "month",
member_dim = "member",
na.rm = TRUE,
ncores = NULL
)
}
\arguments{
\item{data}{A numerical array to be used for the index computation with the
dimensions: 1) latitude, longitude, start date, forecast month, and member
(in case of decadal predictions), 2) latitude, longitude, year, month and
member (in case of historical simulations), or 3) latitude, longitude, year
and month (in case of observations or reanalyses). This data has to be
\item{data}{A numerical array to be used for the index computation with, at least, the
dimensions: 1) latitude, longitude, start date and forecast month
(in case of decadal predictions), 2) latitude, longitude, year and month
(in case of historical simulations or observations). This data has to be
provided, at least, over the whole region needed to compute the index.}
\item{data_lats}{A numeric vector indicating the latitudes of the data.}
......@@ -70,7 +69,7 @@ climatology is calculated over the whole period. If the data are already
anomalies, set it to FALSE. The default value is NULL.\cr
In case of parameter 'type' is 'dcpp', 'indices_for_clim' must be relative
to the first forecast year, and the climatology is automatically computed
over the actual common period for the different forecast years.}
over the common calendar period for the different forecast years.}
\item{year_dim}{A character string indicating the name of the year dimension
The default value is 'year'. Only used if parameter 'type' is 'hist' or
......@@ -80,25 +79,26 @@ The default value is 'year'. Only used if parameter 'type' is 'hist' or
dimension. The default value is 'month'. Only used if parameter 'type' is
'hist' or 'obs'.}
\item{member_dim}{A character string indicating the name of the member
dimension. The default value is 'member'. Only used if parameter 'type' is
'dcpp' or 'hist'.}
\item{na.rm}{A logical value indicanting whether to remove NA values. The default
value is TRUE.}
\item{ncores}{An integer indicating the number of cores to use for parallel
computation. The default value is NULL.}
}
\value{
A numerical array of the SPOD index with the dimensions of:
1) sdate, forecast year, and member (in case of decadal predictions);
2) year and member (in case of historical simulations); or
3) year (in case of observations or reanalyses).
A numerical array with the SPOD index with the same dimensions as data except
the lat_dim, lon_dim and fmonth_dim (month_dim) in case of decadal predictions
(historical simulations or observations). In case of decadal predictions, a new dimension
'fyear' is added.
}
\description{
The South Pacific Ocean Dipole (SPOD) index is related to the El
Nino-Southern Oscillation (ENSO) and the Inderdecadal Pacific Oscillation
(IPO). The SPOD index is computed as the difference of weighted-averaged SST
anomalies over 20ºS-48ºS, 165ºE-190ºE (NW pole) and the weighted-averaged SST
anomalies over 44ºS-65ºS, 220ºE-260ºE (SE pole) (Saurral et al., 2020).
anomalies over 44ºS-65ºS, 220ºE-260ºE (SE pole) (Saurral et al., 2020).
If different members and/or datasets are provided, the climatology (used to
calculate the anomalies) is computed individually for all of them.
}
\examples{
## Observations or reanalyses
......
......@@ -18,16 +18,15 @@ TPI(
indices_for_clim = NULL,
year_dim = "year",
month_dim = "month",
member_dim = "member",
na.rm = TRUE,
ncores = NULL
)
}
\arguments{
\item{data}{A numerical array to be used for the index computation with the
dimensions: 1) latitude, longitude, start date, forecast month, and member
(in case of decadal predictions), 2) latitude, longitude, year, month and
member (in case of historical simulations), or 3) latitude, longitude, year
and month (in case of observations or reanalyses). This data has to be
\item{data}{A numerical array to be used for the index computation with, at least, the
dimensions: 1) latitude, longitude, start date and forecast month
(in case of decadal predictions), 2) latitude, longitude, year and month
(in case of historical simulations or observations). This data has to be
provided, at least, over the whole region needed to compute the index.}
\item{data_lats}{A numeric vector indicating the latitudes of the data.}
......@@ -70,7 +69,7 @@ climatology is calculated over the whole period. If the data are already
anomalies, set it to FALSE. The default value is NULL.\cr
In case of parameter 'type' is 'dcpp', 'indices_for_clim' must be relative
to the first forecast year, and the climatology is automatically computed
over the actual common period for the different forecast years.}
over the common calendar period for the different forecast years.}
\item{year_dim}{A character string indicating the name of the year dimension
The default value is 'year'. Only used if parameter 'type' is 'hist' or
......@@ -80,24 +79,25 @@ The default value is 'year'. Only used if parameter 'type' is 'hist' or
dimension. The default value is 'month'. Only used if parameter 'type' is
'hist' or 'obs'.}
\item{member_dim}{A character string indicating the name of the member
dimension. The default value is 'member'. Only used if parameter 'type' is
'dcpp' or 'hist'.}
\item{na.rm}{A logical value indicanting whether to remove NA values. The default
value is TRUE.}
\item{ncores}{An integer indicating the number of cores to use for parallel
computation. The default value is NULL.}
}
\value{
A numerical array of the TPI index with the dimensions of:
1) sdate, forecast year, and member (in case of decadal predictions);
2) year and member (in case of historical simulations); or
3) year (in case of observations or reanalyses).
A numerical array with the TPI index with the same dimensions as data except
the lat_dim, lon_dim and fmonth_dim (month_dim) in case of decadal predictions
(historical simulations or observations). In case of decadal predictions, a new dimension
'fyear' is added.
}
\description{
The Tripole Index (TPI) for the Interdecadal Pacific Oscillation (IPO) is
computed as the difference of weighted-averaged SST anomalies over 10ºS-10ºN,
170ºE-270ºE minus the mean of the weighted-averaged SST anomalies over
25ºN-45ºN, 140ºE-215ºE and 50ºS-15ºS, 150ºE-200ºE (Henley et al., 2015).
25ºN-45ºN, 140ºE-215ºE and 50ºS-15ºS, 150ºE-200ºE (Henley et al., 2015).
If different members and/or datasets are provided, the climatology (used to
calculate the anomalies) is computed individually for all of them.
}
\examples{
## Observations or reanalyses
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment