scale_columns: Scales data.table columns.

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

Scales data.table columns.

Description

A stackable wrapper for scale to turn it into a stackable transformation

Usage

scale_columns(
  my_dt = NULL,
  col_names = NULL,
  my_summary = "Scale the data by column.",
  sample_key = get_default_sample_key(),
  should_scale = TRUE,
  should_center = TRUE,
  readme_path = NULL
)

Arguments

my_dt	data.table input
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 scaled.
should_scale	Boolean to indicate whether the data should be scaled or not. See scale 'scale' argument.
should_center	Boolean to indicate whether the data should be centered or not. See scale 'center' argument.
readme_path	Optional path to which the comments will be appended.

Details

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ scale_columns ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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