scale.R: Scale.R

In FredHasselman/nlRtsa: nonlineaR time seRies analysis.

Description

Rescale a vector to a user defined range defined by user.

Usage

## S3 method for class 'R'
scale(x, mn = min(x, na.rm = T), mx = max(x, na.rm = T),
  lo = 0, hi = 1)

Arguments

x	Input vector or data frame.
mn	Minimum value of original, defaults to min(x, na.rm = TRUE).
mx	Maximum value of original, defaults to max(x, na.rm = TRUE).
lo	Maximum value to rescale to, defaults to 1.
hi	Minimum value to rescale to, defaults to 0.

Details

Three uses:

1. scale.R(x) - Scale x to data range: min(x.out)==0; max(x.out)==1

2. scale.R(x,mn,mx) - Scale x to arg. range: min(x.out)==mn==0; max(x.out)==mx==1

3. scale.R(x,mn,mx,lo,hi) - Scale x to arg. range: min(x.out)==mn==lo; max(x.out)==mx==hi

Examples

# Works on numeric objects
somenumbers <- cbind(c(-5,100,sqrt(2)),c(exp(1),0,-pi))

scale.R(somenumbers)
scale.R(somenumbers,mn=-100)
# Values < mn will return < lo (default=0)
# Values > mx will return > hi (default=1)
scale.R(somenumbers,mn=-1,mx=99)

scale.R(somenumbers,lo=-1,hi=1)
scale.R(somenumbers,mn=-10,mx=101,lo=-1,hi=4)

FredHasselman/nlRtsa documentation built on May 6, 2019, 5:07 p.m.