package
0.0.0-20200818183458-d966d878d120
Repository: https://github.com/grailbio/bio.git
Documentation: pkg.go.dev

# Functions

Downsample writes read pairs from the two files to r1Out and r2Out.
DownsampleToCount writes read pairs from the two files to r1Out and r2Out.
NewPairScanner creates a new FASTQ pair scanner from the provided R1 and R2 readers.
NewScanner constructs a new Scanner that reads raw FASTQ data from the provided reader.
NewWriter constructs a new FASTQ writer that writes reads to the underlying writer w.

# Constants

All equals ID|Seq|Unk|Qual.
ID causes the Read.ID field to be filled.
Qual causes the Read.Unk field to be filled.
Seq causes the Read.Seq field to be filled.
Unk causes the Read.Unk field to be filled.

# Variables

ErrDiscordant is returned when two underlying FASTQ files are discordant.
ErrInvalid is returned when an invalid FASTQ file is encountered.
ErrShort is returned when a truncated FASTQ file is encountered.

# Structs

PairScanner composes a pair of scanners to scan a pair of FASTQ streams.
A Read is a FASTQ read, comprising an ID, sequence, line 3 ("unknown"), and a quality string.
Scanner provides a convenient interface for reading FASTQ read data.
Writer is a FASTQ file writer.

# Type aliases

Field enumerates FASTQ fields.