From 2031b5e834c7fefe1213a49b65aa1e95e8624f3b Mon Sep 17 00:00:00 2001 From: Eva Rifa Date: Fri, 21 Oct 2022 11:47:00 +0200 Subject: [PATCH] Correct typo from time_dim param word 'function' to 'dimension' --- R/AccumulationExceedingThreshold.R | 4 ++-- R/PeriodAccumulation.R | 4 ++-- R/PeriodMean.R | 4 ++-- R/TotalSpellTimeExceedingThreshold.R | 4 ++-- R/TotalTimeExceedingThreshold.R | 4 ++-- R/WindCapacityFactor.R | 4 ++-- R/WindPowerDensity.R | 4 ++-- man/AccumulationExceedingThreshold.Rd | 2 +- man/CST_AccumulationExceedingThreshold.Rd | 2 +- man/CST_PeriodAccumulation.Rd | 2 +- man/CST_PeriodMean.Rd | 2 +- man/CST_TotalSpellTimeExceedingThreshold.Rd | 2 +- man/CST_TotalTimeExceedingThreshold.Rd | 2 +- man/CST_WindCapacityFactor.Rd | 2 +- man/CST_WindPowerDensity.Rd | 2 +- man/PeriodAccumulation.Rd | 2 +- man/PeriodMean.Rd | 2 +- man/TotalSpellTimeExceedingThreshold.Rd | 2 +- man/TotalTimeExceedingThreshold.Rd | 2 +- man/WindCapacityFactor.Rd | 2 +- man/WindPowerDensity.Rd | 2 +- 21 files changed, 28 insertions(+), 28 deletions(-) diff --git a/R/AccumulationExceedingThreshold.R b/R/AccumulationExceedingThreshold.R index 62845ba..cceb07b 100644 --- a/R/AccumulationExceedingThreshold.R +++ b/R/AccumulationExceedingThreshold.R @@ -29,7 +29,7 @@ #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'ftime'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. @@ -119,7 +119,7 @@ CST_AccumulationExceedingThreshold <- function(data, threshold, op = '>', #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'ftime'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. diff --git a/R/PeriodAccumulation.R b/R/PeriodAccumulation.R index 5a672e0..ab093be 100644 --- a/R/PeriodAccumulation.R +++ b/R/PeriodAccumulation.R @@ -21,7 +21,7 @@ #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'ftime'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. @@ -110,7 +110,7 @@ CST_PeriodAccumulation <- function(data, start = NULL, end = NULL, #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'time'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. diff --git a/R/PeriodMean.R b/R/PeriodMean.R index 73700fd..55f28cd 100644 --- a/R/PeriodMean.R +++ b/R/PeriodMean.R @@ -21,7 +21,7 @@ #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'ftime'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. @@ -98,7 +98,7 @@ CST_PeriodMean <- function(data, start = NULL, end = NULL, #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'ftime'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. diff --git a/R/TotalSpellTimeExceedingThreshold.R b/R/TotalSpellTimeExceedingThreshold.R index 9a5de43..7039f28 100644 --- a/R/TotalSpellTimeExceedingThreshold.R +++ b/R/TotalSpellTimeExceedingThreshold.R @@ -34,7 +34,7 @@ #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'ftime'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. @@ -127,7 +127,7 @@ CST_TotalSpellTimeExceedingThreshold <- function(data, threshold, spell, op = '> #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'ftime'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. diff --git a/R/TotalTimeExceedingThreshold.R b/R/TotalTimeExceedingThreshold.R index 5e800f0..6e6e72d 100644 --- a/R/TotalTimeExceedingThreshold.R +++ b/R/TotalTimeExceedingThreshold.R @@ -37,7 +37,7 @@ #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'ftime'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. @@ -134,7 +134,7 @@ CST_TotalTimeExceedingThreshold <- function(data, threshold, op = '>', #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'time'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. diff --git a/R/WindCapacityFactor.R b/R/WindCapacityFactor.R index 659e6d4..ee542eb 100644 --- a/R/WindCapacityFactor.R +++ b/R/WindCapacityFactor.R @@ -30,7 +30,7 @@ #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'ftime'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. @@ -120,7 +120,7 @@ CST_WindCapacityFactor <- function(wind, IEC_class = c("I", "I/II", "II", "II/II #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'ftime'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. diff --git a/R/WindPowerDensity.R b/R/WindPowerDensity.R index 6bbc597..bbdd07d 100644 --- a/R/WindPowerDensity.R +++ b/R/WindPowerDensity.R @@ -20,7 +20,7 @@ #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'ftime'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. @@ -100,7 +100,7 @@ CST_WindPowerDensity <- function(wind, ro = 1.225, start = NULL, end = NULL, #' select from the data by providing a list of two elements: the final day of #' the period and the final month of the period. By default it is set to NULL #' and the indicator is computed using all the data provided in \code{data}. -#'@param time_dim A character string indicating the name of the function to +#'@param time_dim A character string indicating the name of the dimension to #' compute the indicator. By default, it is set to 'ftime'. More than one #' dimension name matching the dimensions provided in the object #' \code{data$data} can be specified. diff --git a/man/AccumulationExceedingThreshold.Rd b/man/AccumulationExceedingThreshold.Rd index f7e0982..e646dc6 100644 --- a/man/AccumulationExceedingThreshold.Rd +++ b/man/AccumulationExceedingThreshold.Rd @@ -44,7 +44,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} diff --git a/man/CST_AccumulationExceedingThreshold.Rd b/man/CST_AccumulationExceedingThreshold.Rd index 9785f97..0754c24 100644 --- a/man/CST_AccumulationExceedingThreshold.Rd +++ b/man/CST_AccumulationExceedingThreshold.Rd @@ -40,7 +40,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} diff --git a/man/CST_PeriodAccumulation.Rd b/man/CST_PeriodAccumulation.Rd index 5a2c3ce..afd6080 100644 --- a/man/CST_PeriodAccumulation.Rd +++ b/man/CST_PeriodAccumulation.Rd @@ -28,7 +28,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} diff --git a/man/CST_PeriodMean.Rd b/man/CST_PeriodMean.Rd index 574e476..c4e3dae 100644 --- a/man/CST_PeriodMean.Rd +++ b/man/CST_PeriodMean.Rd @@ -28,7 +28,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} diff --git a/man/CST_TotalSpellTimeExceedingThreshold.Rd b/man/CST_TotalSpellTimeExceedingThreshold.Rd index d395ae6..d19415e 100644 --- a/man/CST_TotalSpellTimeExceedingThreshold.Rd +++ b/man/CST_TotalSpellTimeExceedingThreshold.Rd @@ -40,7 +40,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} diff --git a/man/CST_TotalTimeExceedingThreshold.Rd b/man/CST_TotalTimeExceedingThreshold.Rd index 3c5c11f..980d77b 100644 --- a/man/CST_TotalTimeExceedingThreshold.Rd +++ b/man/CST_TotalTimeExceedingThreshold.Rd @@ -38,7 +38,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} diff --git a/man/CST_WindCapacityFactor.Rd b/man/CST_WindCapacityFactor.Rd index 28f437f..1dd879b 100644 --- a/man/CST_WindCapacityFactor.Rd +++ b/man/CST_WindCapacityFactor.Rd @@ -34,7 +34,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} diff --git a/man/CST_WindPowerDensity.Rd b/man/CST_WindPowerDensity.Rd index 9e53457..9c3040c 100644 --- a/man/CST_WindPowerDensity.Rd +++ b/man/CST_WindPowerDensity.Rd @@ -32,7 +32,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} diff --git a/man/PeriodAccumulation.Rd b/man/PeriodAccumulation.Rd index 1f23e66..f6e6d3b 100644 --- a/man/PeriodAccumulation.Rd +++ b/man/PeriodAccumulation.Rd @@ -32,7 +32,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'time'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} diff --git a/man/PeriodMean.Rd b/man/PeriodMean.Rd index 19fb9bf..803a3f2 100644 --- a/man/PeriodMean.Rd +++ b/man/PeriodMean.Rd @@ -32,7 +32,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} diff --git a/man/TotalSpellTimeExceedingThreshold.Rd b/man/TotalSpellTimeExceedingThreshold.Rd index 2bcebfa..37fd6cc 100644 --- a/man/TotalSpellTimeExceedingThreshold.Rd +++ b/man/TotalSpellTimeExceedingThreshold.Rd @@ -43,7 +43,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} diff --git a/man/TotalTimeExceedingThreshold.Rd b/man/TotalTimeExceedingThreshold.Rd index 119d392..524f938 100644 --- a/man/TotalTimeExceedingThreshold.Rd +++ b/man/TotalTimeExceedingThreshold.Rd @@ -42,7 +42,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'time'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} diff --git a/man/WindCapacityFactor.Rd b/man/WindCapacityFactor.Rd index 4779ff0..557771e 100644 --- a/man/WindCapacityFactor.Rd +++ b/man/WindCapacityFactor.Rd @@ -40,7 +40,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} diff --git a/man/WindPowerDensity.Rd b/man/WindPowerDensity.Rd index af919a6..8e3c8e3 100644 --- a/man/WindPowerDensity.Rd +++ b/man/WindPowerDensity.Rd @@ -37,7 +37,7 @@ select from the data by providing a list of two elements: the final day of the period and the final month of the period. By default it is set to NULL and the indicator is computed using all the data provided in \code{data}.} -\item{time_dim}{A character string indicating the name of the function to +\item{time_dim}{A character string indicating the name of the dimension to compute the indicator. By default, it is set to 'ftime'. More than one dimension name matching the dimensions provided in the object \code{data$data} can be specified.} -- GitLab