File: getErrors.Rd

package info (click to toggle)
r-bioc-dada2 1.34.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 3,016 kB
  • sloc: cpp: 3,096; makefile: 5
file content (33 lines) | stat: -rw-r--r-- 1,067 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/errorModels.R
\name{getErrors}
\alias{getErrors}
\title{Extract already computed error rates.}
\usage{
getErrors(obj, detailed = FALSE, enforce = TRUE)
}
\arguments{
\item{obj}{(Required). An R object with error rates.
Supported objects: dada-class; list of dada-class; numeric matrix; named list with $err_out, $err_in, $trans.}

\item{detailed}{(Optional). Default FALSE.
If FALSE, an error rate matrix corresponding to $err_out is returned.
If TRUE, a named list with $err_out, $err_in and $trans. $err_in and $trans can be NULL.}

\item{enforce}{(Optional). Default TRUE.
If TRUE, will check validity of $err_out and error if invalid or NULL.}
}
\value{
A numeric matrix of error rates.
 Or, if detailed=TRUE, a named list with $err_out, $err_in and $trans.
}
\description{
Extract already computed error rates.
}
\examples{
 fl1 <- system.file("extdata", "sam1F.fastq.gz", package="dada2")
 drp <- derepFastq(fl1)
 dd <- dada(drp, err=NULL, selfConsist=TRUE)
 err <- getErrors(dd)

}