consmat: Construct a consensus matrix from pileup.

Description Usage Arguments Details Value Examples

View source: R/consmat.R

Description

Accessor and replacement methods are available: n(consmat), ins(consmat), offsetBases(consmat), is.freq(consmat).

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
consmat(x, freq = TRUE, ...)

consmat(x) <- value

n(consmat)

n(consmat) <- value

ins(consmat)

ins(consmat) <- value

offsetBases(consmat)

offsetBases(consmat) <- value

is.freq(consmat)

Arguments

x

A pileup object. Additional inputs can be a matrix, tbl_df or consmat objects.

freq

If TRUE then frequencies are reported, otherwise counts.

...

Additional arguments such as n, offsetBases, insertions

value

The value to replace with.

consmat

The consmat object that is changed.

Details

consmat: a matrix with positions row names and nucleotides as column manes. A consmat object includes the attributes:

n

<integer>; Number of reads per row.

freq

<logical>; Is it a frequency matrix or a count matrix.

offsetBases

<integer>; OffsetBases

insertions

<integer>; Insertions

Value

A consmat object.

Examples

1
2
print("TODO: ADD EXAMPLES")
###

DKMS-LSL/dr2s documentation built on March 14, 2021, 2:46 p.m.