log_transform_plus: Does a log transformation of the data plus a specified value.

In Benjamin-Vincent-Lab/binfotron: Binfotron Bioinformatics Analysis Tools Suite

Does a log transformation of the data plus a specified value.

Description

This is a wrapper for log that also allows the adding of a value prior to the transform.

Usage

log_transform_plus(
  my_dt = NULL,
  add_value = 1,
  base = 2,
  col_names = NULL,
  my_summary = NULL,
  sample_key = get_default_sample_key(),
  readme_path = NULL
)

Arguments

my_dt	data.table input
add_value	Numeric value that will be added prior to the log transform.
base	Numberic value providing the base for the log transform See log 'base.
col_names	Vector of character strings to name the columns that will have this operation performed on them. Uses operatable_columns
my_summary	Character string to change the default comment that will be appended to my_dt.
sample_key	Character string to specify the column that is the sample key. This column will not be operated upon.
readme_path	Optional path to which the comments will be appended.

Details

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ log_transform_plus ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Benjamin-Vincent-Lab/binfotron documentation built on Oct. 1, 2024, 8:33 p.m.