Update norm_*_params info

PetoLau · Mar 25, 2020 · bd26fad · bd26fad
1 parent 05a7ff5
commit bd26fad
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 2 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -2,7 +2,7 @@ Package: TSrepr
 Type: Package
 Title: Time Series Representations
 Version: 1.0.4
-Date: 2020-03-22
+Date: 2020-03-25
 Authors@R: person("Peter", "Laurinec", email = "tsreprpackage@gmail.com",
   role = c("aut", "cre"), 
   comment = c(ORCID = "0000-0002-3501-8783"))

diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,4 @@
-# TSrepr 1.0.4 2020/03/22
+# TSrepr 1.0.4 2020/03/25
 
   * Fixed 0/0 case in forecasting accuracy measures
   * Refactor of data.table::melt cases in vignettes, because of data.table package changes

diff --git a/R/TSrepr-package.R b/R/TSrepr-package.R
@@ -29,6 +29,7 @@
 #' \item \link[TSrepr]{repr_windowing} - applies above mentioned representations to every window of a time series
 #' \item \link[TSrepr]{repr_matrix} - applies above mentioned representations to every row of a matrix of time series
 #' \item \link[TSrepr]{norm_z}, \link[TSrepr]{norm_min_max} - normalisation functions
+#' \item \link[TSrepr]{norm_z_params}, \link[TSrepr]{norm_min_max_params} - normalisation functions with defined parameters
 #' \item \link[TSrepr]{norm_z_list}, \link[TSrepr]{norm_min_max_list} - normalisation functions with output also of scaling parameters
 #' \item \link[TSrepr]{denorm_z}, \link[TSrepr]{denorm_min_max} - denormalisation functions
 #' }

diff --git a/README.Rmd b/README.Rmd
@@ -66,6 +66,7 @@ Additional useful functions are implemented as:
   * Matrix of representations (`repr_matrix`) - applies above mentioned representations to every row of a matrix of time series
   * Normalisation functions - z-score (`norm_z`), min-max (`norm_min_max`)
   * Normalisation functions with output also of scaling parameters - z-score (`norm_z_list`), min-max (`norm_min_max_list`)
+  * Normalisation functions with defined parameters - z-score (`norm_z_params`), min-max (`norm_min_max_params`)
   * Denormalisation functions - z-score (`denorm_z`), min-max (`denorm_min_max`)
   * Forecasting accuracy measures - MSE, MAE, RMSE, MdAE, MAPE, sMAPE, MAAPE, MASE
 

diff --git a/README.md b/README.md
@@ -73,6 +73,8 @@ Additional useful functions are implemented as:
     (`norm_min_max`)
   - Normalisation functions with output also of scaling parameters -
     z-score (`norm_z_list`), min-max (`norm_min_max_list`)
+  - Normalisation functions with defined parameters - z-score
+    (`norm_z_params`), min-max (`norm_min_max_params`)
   - Denormalisation functions - z-score (`denorm_z`), min-max
     (`denorm_min_max`)
   - Forecasting accuracy measures - MSE, MAE, RMSE, MdAE, MAPE, sMAPE,

diff --git a/man/TSrepr.Rd b/man/TSrepr.Rd