NonlinearRangeRescale: NonlinearRangeRescale

Description Usage Arguments Details Value

Description

Performs a nonlinear range rescale according the complement of a Gamma cumulative density function.

Usage

1
2
NonlinearRangeRescale(x, min, max, lowBound, upBound, pars,
  movement_kernel)

Arguments

x

value to rescale.

min

minimum value of x on its original scale. Default is NULL.

max

maximum value of x on its original scale. Default is NULL.

lowBound

the minimum value of the desired scale. Default is 1.

upBound

the maximum value of the desired scale. Default is NULL.

pars

a list or numeric vector containing the scale and shape parameters of a Gamma distribution in that order.

movement_kernel

a raster or extent object used to calculate the value for upBound.

negative

a logical indicating whether or not the final rescaled value should be multiplied by -1.

Details

Based on code written by Javan Bauder and Kevin McGarigal. This function currently only uses a Gamma distribution. Arguments whose defaults are NULL are calculated internally based on the Gamma parameters provided and the extent of the movement_kernel raster or extent.

Value

rescaled x


Blakemassey/baear documentation built on Dec. 25, 2021, 9:48 a.m.