GE (version 0.2.5)

ratio_adjust: Ratio Adjustment

Description

Adjust ratios to new values.

Usage

ratio_adjust(
  ratio,
  coef = 0.8,
  method = c("log", "left.linear", "trunc.log", "linear")
)

Arguments

ratio

a numeric vector or a positive numeric n-by-m matrix.

coef

a positive number, a positive numeric vector or a positive numeric n-by-m matrix.

method

a character string specifying the adjustment method.

Value

A vector or a matrix with dimensions the same as the argument ratio.

Details

For a positive ratio and the following methods, the return values are as follows:

• log : coef * log(ratio) + 1, if ratio >= 1; 1 / (coef * log(1 / ratio) + 1), if ratio < 1.

• left.linear : 1 / (coef * (1 / ratio - 1) + 1), if ratio >= 1; 1 + coef * (ratio - 1), if ratio < 1.

• trunc.log : max(coef * log(ratio) + 1, 0).

• linear : coef * (ratio - 1) + 1.

Examples

# NOT RUN {
ratio_adjust(10, 0.8)
ratio_adjust(0.1, 0.8)

x <- seq(0.01, 2, 0.01)
plot(x, x, type = "l")
lines(x, ratio_adjust(x, 0.8, method = "log"), col = "red")
lines(x, ratio_adjust(x, 0.8, method = "left.linear"), col = "blue")
lines(x, ratio_adjust(x, 0.8, method = "trunc.log"), col = "green")

X <- replicate(3, x)
Y <- ratio_adjust(X, c(0.8, 1, 1.2))
matplot(x, Y, type = "l")
# }