Commit 971376cc authored by Carlos Delgado Torres's avatar Carlos Delgado Torres
Browse files

improved documentation

parent c8197660
Pipeline #5286 passed with stage
in 4 minutes and 29 seconds
......@@ -6,7 +6,8 @@
#'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.
#'
#'@param data A numerical array to be used for the index computation with, at least, the
#' dimensions: 1) latitude, longitude, start date and forecast month
......
......@@ -2,7 +2,8 @@
#'
#'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.
#'
#'@param data_tas A numerical array with the surface air temperature data
#' to be used for the index computation with, at least, the
......
#'Compute the Global Surface Air Temperature (GSAT) anomalies
#'
#'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.
#'
#'@param data A numerical array to be used for the index computation with, at least, the
#' dimensions: 1) latitude, longitude, start date and forecast month
......
......@@ -4,7 +4,9 @@
#'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.
#'
#'@param data A numerical array to be used for the index computation with, at least, the
#' dimensions: 1) latitude, longitude, start date and forecast month
......
......@@ -3,7 +3,9 @@
#'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.
#'
#'@param data A numerical array to be used for the index computation with, at least, the
#' dimensions: 1) latitude, longitude, start date and forecast month
......
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