From e76c03c56b938f6b0b9f2147c099ccba2f744be0 Mon Sep 17 00:00:00 2001 From: aho Date: Thu, 12 Sep 2019 17:38:57 +0200 Subject: [PATCH] Correct Trend() parameter documentation. --- R/Trend.R | 16 +++------------- man/Trend.Rd | 22 +++------------------- 2 files changed, 6 insertions(+), 32 deletions(-) diff --git a/R/Trend.R b/R/Trend.R index 98a71bf3..d8bfc601 100644 --- a/R/Trend.R +++ b/R/Trend.R @@ -8,26 +8,16 @@ #'.Trend provides the same functionality but taking a matrix ensemble members #'as input (exp). #' -#'@param var Array of any number of dimensions up to 10. -#'@param exp M by N matrix of M forecasts from N ensemble members. -#'@param interval Number of months/years between 2 points along posTR -#' dimension.\cr -#' Default = 1.\cr -#' The trend would be provided in number of units per month or year. -#'@param siglev Confidence level for the computation of confidence interval. -#' 0.95 by default. -#'@param conf Whether to compute the confidence levels or not. TRUE by default. -#'@param posTR Position along which to compute the trend. #'@param var An array of any number of dimensions up to 10. -#'@param exp An M by N matrix representing M forecasts from N ensemble members. +#'@param posTR An integer indicating the position along which to compute the +#' trend. #'@param interval A number of months/years between 2 points along posTR #' dimension. Set 1 as default. #'@param siglev A numeric value indicating the confidence level for the #' computation of confidence interval. Set 0.95 as default. #'@param conf A logical value indicating whether to compute the confidence #' levels or not. Set TRUE as default. -#'@param posTR An integer indicating the position along which to compute the -#' trend. +#'@param exp An M by N matrix representing M forecasts from N ensemble members. #' #'@return #'\item{$trend}{ diff --git a/man/Trend.Rd b/man/Trend.Rd index 4326a1e3..71d2e1be 100644 --- a/man/Trend.Rd +++ b/man/Trend.Rd @@ -10,25 +10,10 @@ Trend(var, posTR = 2, interval = 1, siglev = 0.95, conf = TRUE) .Trend(exp, interval = 1, siglev = 0.95, conf = TRUE) } \arguments{ -\item{var}{Array of any number of dimensions up to 10.} - -\item{posTR}{Position along which to compute the trend.} - -\item{interval}{Number of months/years between 2 points along posTR -dimension.\cr -Default = 1.\cr -The trend would be provided in number of units per month or year.} - -\item{siglev}{Confidence level for the computation of confidence interval. -0.95 by default.} - -\item{conf}{Whether to compute the confidence levels or not. TRUE by default.} - -\item{exp}{M by N matrix of M forecasts from N ensemble members.} - \item{var}{An array of any number of dimensions up to 10.} -\item{exp}{An M by N matrix representing M forecasts from N ensemble members.} +\item{posTR}{An integer indicating the position along which to compute the +trend.} \item{interval}{A number of months/years between 2 points along posTR dimension. Set 1 as default.} @@ -39,8 +24,7 @@ computation of confidence interval. Set 0.95 as default.} \item{conf}{A logical value indicating whether to compute the confidence levels or not. Set TRUE as default.} -\item{posTR}{An integer indicating the position along which to compute the -trend.} +\item{exp}{An M by N matrix representing M forecasts from N ensemble members.} } \value{ \item{$trend}{ -- GitLab