From 6562c4e0f92eb31d46fac608f9898fbfc316d572 Mon Sep 17 00:00:00 2001 From: aho Date: Thu, 20 Jan 2022 11:59:40 +0100 Subject: [PATCH 1/3] Clarify the 'method' options in documentation --- R/Clim.R | 3 ++- man/Clim.Rd | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/R/Clim.R b/R/Clim.R index d01cf5d..6380bd2 100644 --- a/R/Clim.R +++ b/R/Clim.R @@ -23,7 +23,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 50ec0d9..3237786 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'.} -- GitLab From 1fcc74a1b3d3150d3968e72602d844035514022c Mon Sep 17 00:00:00 2001 From: aho Date: Thu, 20 Jan 2022 13:02:54 +0100 Subject: [PATCH 2/3] Add citation link --- R/Clim.R | 4 ++-- man/Clim.Rd | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/R/Clim.R b/R/Clim.R index 6380bd2..52fe7c7 100644 --- a/R/Clim.R +++ b/R/Clim.R @@ -4,8 +4,8 @@ #'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{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 diff --git a/man/Clim.Rd b/man/Clim.Rd index 3237786..b499e88 100644 --- a/man/Clim.Rd +++ b/man/Clim.Rd @@ -72,8 +72,8 @@ 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{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 -- GitLab From 364e582bda029dbb8d1cd0f134ecd9e64f9ed99b Mon Sep 17 00:00:00 2001 From: aho Date: Thu, 20 Jan 2022 15:29:16 +0100 Subject: [PATCH 3/3] Supplement the details for each method --- R/Clim.R | 5 ++++- man/Clim.Rd | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/R/Clim.R b/R/Clim.R index 52fe7c7..59f8bc9 100644 --- a/R/Clim.R +++ b/R/Clim.R @@ -3,7 +3,7 @@ #'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{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)} #'} @@ -11,6 +11,9 @@ #'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'. diff --git a/man/Clim.Rd b/man/Clim.Rd index b499e88..cf58525 100644 --- a/man/Clim.Rd +++ b/man/Clim.Rd @@ -71,7 +71,7 @@ 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{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)} } @@ -79,6 +79,9 @@ 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: -- GitLab