rev_asinh: Reverses arcsinh transformation with cofactor 'scale_factor'...

View source: R/utils.R

rev_asinhR Documentation

Reverses arcsinh transformation with cofactor 'scale_factor' and a shift of 'shift_factor'.

Description

Reverses arcsinh transformation with cofactor 'scale_factor' and a shift of 'shift_factor'.

Usage

rev_asinh(x, shift_factor, scale_factor)

Arguments

x

A numeric vector.

shift_factor

The scalar value 'a' in the following equation used to transform high-dimensional cytometry raw data ion counts using the hyperbolic arcsinh function: 'new_x <- asinh(a + b * x)'.

scale_factor

The scalar value 'b' in the following equation used to transform high-dimensional cytometry raw data ion counts using the hyperbolic arcsinh function: 'new_x <- asinh(a + b * x)'.

Value

A numeric vector after undergoing reverse arcsinh transformation

Examples

shift_factor <- 0
scale_factor <- 1 / 5

input_value <- 20
asinh_value <- asinh(shift_factor + input_value * scale_factor)

restored_value <- rev_asinh(asinh_value, shift_factor, scale_factor)


keyes-timothy/tidytof documentation built on Aug. 28, 2024, 8:37 a.m.