do.asinh: do.asinh - Transform data in selected columns using ArcSinH

Description Usage Arguments Value References See Also

View source: R/do.asinh.R

Description

This function allows you to transform the data in selected columns using ArcSinH with a specified co-factor

Usage

1
do.asinh(dat, use.cols, cofactor = 5, append.cf = FALSE, reduce.noise = FALSE)

Arguments

dat

NO DEFAULT. data.table Input sample.

use.cols

NO DEFAULT. Vector of character column names – these columns will be transformed and added to the data.table as new columns.

cofactor

DEFAULT = 5. Co-factor to use for arcsinh transformation.

append.cf

DEFAULT = FALSE. Appends the co-factor used to the end of the name of the transformed columns.

reduce.noise

DEFAULT = FALSE. This is an experimental calculation which should reduce noise from negative values. Use with caution.

Value

A data.table with new columns added, that contain the asinh transformed data.

References

https://sydneycytometry.org.au/spectre

See Also

https://sydneycytometry.org.au/spectre for usage instructions and vignettes.


sydneycytometry/Spectre documentation built on March 20, 2021, 2:15 a.m.