cmuts norm

Purpose

Experiment-independent normalization of reactivity rates.

Requires

Usage

Every input given to one run shares a single norm, and each is written to an output of its own. -o is repeated once per input and paired with them in order.

cmuts norm -o apo-normalized.h5 -o holo-normalized.h5 apo.h5 holo.h5

Running the inputs separately gives each its own norm instead.

cmuts norm -o apo-normalized.h5 apo.h5
cmuts norm -o holo-normalized.h5 holo.h5

This is only suggested if the two experiments had significantly different conditions which are not directly comparable.

Normalization Schemes

All normalization schemes except value compute the norm using the aggregated mismatch, insertion, and deletion rates. Only the positions whose coverage exceeds --min-coverage contribute to it.

The default ubr scheme computes the norm as the 90th percentile of the aggregate rate. The outlier scheme drops the highest 2% of the aggregate rate as outliers and averages what lies between there and the highest 10%. The value scheme uses the norm provided in --value.

A norm that comes out as zero, negative, or undefined is not applied and is recorded as NaN.

Output

Dataset

Source

mismatches/rate

Divided by the norm.

mismatches/error

Divided by the norm.

insertions/rate

Divided by the norm.

insertions/error

Divided by the norm.

deletions/rate

Divided by the norm.

deletions/error

Divided by the norm.

terminations/rate

Divided by the norm.

terminations/error

Divided by the norm.

norm

Estimated from the input per the specified scheme.

coverage

Copied from the input.

sequence

Copied from the input.

reads/length-histogram

Copied from the input.

reads/quality-histogram

Copied from the input.

reads/primary/counted

Copied from the input.

reads/primary/rejected

Copied from the input.

reads/supplementary/counted

Copied from the input.

reads/supplementary/rejected

Copied from the input.

reads/unmapped

Copied from the input.

CLI Options

Arguments

Argument

Description

RATES...

the reactivities to normalize

Input and output

Option

Description

-o, --output HDF5

write one input’s results to this file; repeat once per input (required)

--overwrite

replace the output files if they already exist

Normalization

Option

Description

--norm SCHEME

where the norm comes from (ubr, outlier, value; default ubr)

--value NORM

divide by this norm, in place of computing one (with --norm value; default 1)

--min-coverage N

coverage a position needs before its rate sets the norm (with --norm ubr or --norm outlier; default 500)

Information

Option

Description

-h, --help

show this help and exit

-V, --version

show the version and exit

Advanced

Accepted, and left out of --help.

Option

Description

--dump-options

describe every argument as JSON and exit

--dump-layout

describe the output format as JSON and exit