normalise_range: Normalze time series using min-max range normalisation method

View source: R/transformation.R

normalise_rangeR Documentation

Normalze time series using min-max range normalisation method

Description

Normalze time series using min-max range normalisation method

Usage

normalise_range(
  data,
  lower = 0,
  upper = 1,
  lowerThreshold = NULL,
  upperThreshold = NULL,
  scalingAttr = NULL
)

Arguments

data

<data.frame> containing a set of time series to normalise or an <array> of numerical values to normalise.

lower

<float> lower value of the resultant range.

upper

<float> upper value of the resultant range.

lowerThreshold

<float> lower threshold value.

upperThreshold

<float> upper threshold value.

scalingAttr

<data.frame> setting min-max threshold for each variable. Column names: column names specified in data argument; Row names: min, max. In case of NULL (default value), lowerThreshold or upperThreshold will be used.

Value

<list> containing two keys: "values" and "scalingAttr". The former consists on a <data.frame> or an <array> with the normalised values, depending the class of data argument. The latter consists on the scaling attributes used for normalisation.


biggproject/biggr documentation built on Oct. 2, 2024, 11:13 p.m.