diff --git a/R/Clim.R b/R/Clim.R index d01cf5d91ec219dd7b9124abccabb392d1f35215..59f8bc99f6fa4202c76c68c8d7c93a377d5797dd 100644 --- a/R/Clim.R +++ b/R/Clim.R @@ -3,14 +3,17 @@ #'This function computes per-pair climatologies for the experimental #'and observational data using one of the following methods: #'\enumerate{ -#' \item{per-pair method (Garcia-Serrano and Doblas-Reyes, CD, 2012)} -#' \item{Kharin method (Karin et al, GRL, 2012)} -#' \item{Fuckar method (Fuckar et al, GRL, 2014)} +#' \item{per-pair method (Garcia-Serrano and Doblas-Reyes, CD, 2012 https://doi.org/10.1007/s00382-012-1413-1)} +#' \item{Kharin method (Kharin et al, GRL, 2012 https://doi.org/10.1029/2012GL052647)} +#' \item{Fuckar method (Fuckar et al, GRL, 2014 https://doi.org/10.1002/2014GL060815)} #'} #'Per-pair climatology means that only the startdates covered by the #'whole experiments/observational dataset will be used. In other words, the #'startdates which are not all available along 'dat_dim' dimension of both #'the 'exp' and 'obs' are excluded when computing the climatologies. +#'Kharin method is the linear trend bias correction method, and Fuckar method +#'is the initial condition bias correction method. The two methods both do the +#'per-pair correction beforehand. #' #'@param exp A named numeric array of experimental data, with at least two #' dimensions 'time_dim' and 'dat_dim'. @@ -23,7 +26,8 @@ #' complete along 'dat_dim', this startdate along 'dat_dim' will be discarded. #' The default value is "c('dataset', 'member')". #'@param method A character string indicating the method to be used. The -#' options include 'clim', 'kharin', and 'NDV'. The default value is 'clim'. +#' options include 'clim' (per-pair method), 'kharin' (Kharin method), and +#' 'NDV' (Fuckar method). The default value is 'clim'. #'@param ftime_dim A character string indicating the name of forecast time #' dimension. Only used when method = 'NDV'. The default value is 'ftime'. #'@param memb A logical value indicating whether to remain 'memb_dim' dimension diff --git a/man/Clim.Rd b/man/Clim.Rd index 50ec0d9c90d7e2dc1b0486de820e657ee84aa325..cf5852590a0f4d76984f195450e3a131d253f84b 100644 --- a/man/Clim.Rd +++ b/man/Clim.Rd @@ -33,7 +33,8 @@ complete along 'dat_dim', this startdate along 'dat_dim' will be discarded. The default value is "c('dataset', 'member')".} \item{method}{A character string indicating the method to be used. The -options include 'clim', 'kharin', and 'NDV'. The default value is 'clim'.} +options include 'clim' (per-pair method), 'kharin' (Kharin method), and +'NDV' (Fuckar method). The default value is 'clim'.} \item{ftime_dim}{A character string indicating the name of forecast time dimension. Only used when method = 'NDV'. The default value is 'ftime'.} @@ -70,14 +71,17 @@ A list of 2: This function computes per-pair climatologies for the experimental and observational data using one of the following methods: \enumerate{ - \item{per-pair method (Garcia-Serrano and Doblas-Reyes, CD, 2012)} - \item{Kharin method (Karin et al, GRL, 2012)} - \item{Fuckar method (Fuckar et al, GRL, 2014)} + \item{per-pair method (Garcia-Serrano and Doblas-Reyes, CD, 2012 https://doi.org/10.1007/s00382-012-1413-1)} + \item{Kharin method (Kharin et al, GRL, 2012 https://doi.org/10.1029/2012GL052647)} + \item{Fuckar method (Fuckar et al, GRL, 2014 https://doi.org/10.1002/2014GL060815)} } Per-pair climatology means that only the startdates covered by the whole experiments/observational dataset will be used. In other words, the startdates which are not all available along 'dat_dim' dimension of both the 'exp' and 'obs' are excluded when computing the climatologies. +Kharin method is the linear trend bias correction method, and Fuckar method +is the initial condition bias correction method. The two methods both do the +per-pair correction beforehand. } \examples{ # Load sample data as in Load() example: