File: getSequences.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 (37 lines) | stat: -rw-r--r-- 1,428 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
34
35
36
37
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/misc.R
\name{getSequences}
\alias{getSequences}
\title{Get vector of sequences from input object.}
\usage{
getSequences(object, collapse = FALSE, silence = TRUE)
}
\arguments{
\item{object}{(Required). The object from which to extract the sequences.}

\item{collapse}{(Optional). Default FALSE.
Should duplicate sequences detected in \code{object} be collapsed together, thereby
imposing uniqueness on non-unique input.}

\item{silence}{(Optional). Default TRUE.
Suppress reporting of the detection and merger of duplicated input sequences.}
}
\value{
\code{character}. A character vector of the sequences.
}
\description{
This function extracts the sequences from several different data objects, including
 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. This function 
 wraps the \code{\link{getUniques}} function, but return only the names (i.e. the sequences).
 Can also be provided the file path to a fasta or fastq file, a taxonomy table, or a
 DNAStringSet object. Sequences are coerced to upper-case characters.
}
\examples{
derep1 = derepFastq(system.file("extdata", "sam1F.fastq.gz", package="dada2"))
dada1 <- dada(derep1, err=tperr1)
getSequences(derep1)[1:5]
getSequences(dada1)[1:5]
getSequences(dada1$clustering)[1:5]

}