forked from benjjneb/dada2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgetUniques.Rd
38 lines (34 loc) · 1.35 KB
/
getUniques.Rd
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
34
35
36
37
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/misc.R
\name{getUniques}
\alias{getUniques}
\title{Get the uniques-vector from the input object.}
\usage{
getUniques(object, collapse = TRUE, silence = FALSE)
}
\arguments{
\item{object}{(Required). The object from which to extract the \code{\link{uniques-vector}}.}
\item{collapse}{(Optional). Default TRUE.
Should duplicate sequences detected in \code{object} be collapsed together, thereby
imposing uniqueness on non-unique input.}
\item{silence}{(Optional). Default FALSE.
Suppress reporting of the detection and merger of duplicated input sequences.}
}
\value{
\code{integer}.
An integer vector named by unique sequence and valued by abundance.
}
\description{
This function extracts the \code{\link{uniques-vector}} from several different data objects,
including \code{\link{dada-class}} and \code{\link{derep-class}} objects, as well as
\code{data.frame} objects that have both $sequence and $abundance columns.
The return value is an integer vector named by sequence and valued by abundance. If the input is
already in \code{\link{uniques-vector}} format, that same vector will be returned.
}
\examples{
derep1 = derepFastq(system.file("extdata", "sam1F.fastq.gz", package="dada2"))
dada1 <- dada(derep1, err=tperr1)
getUniques(derep1)
getUniques(dada1)
getUniques(dada1$clustering)
}