norm_tornado: Normalise samples

Description Usage Arguments Value See Also Examples

View source: R/shape_tornado.R

Description

Normalise the samples in a TornadoExperiment by dividing their values by some scaling factor.

Usage

1
2
3
4
5
6
norm_tornado(
  tornado,
  scale,
  assay_name = assayNames(tornado),
  assay_to = assay_name
)

Arguments

tornado

A TornadoExperiment object.

scale

A numeric vector or length ncol(tornado) with normalisation factors.

assay_name

A character(1): one of the assay names.

assay_to

A character(1) for the target assay name for the normalised data. Defaults to the assay_name assay, thereby replacing input data.

Value

A TornadoExperiment object.

See Also

Other tornado utilities: flatten_features(), melt_tornado(), sort_tornado()

Examples

1
2
tor <- dummy_tornado()
tor <- norm_tornado(tor, c(1, 2))

teunbrand/tornadoplot documentation built on Dec. 23, 2021, 8:48 a.m.