fastq

package
Version: v0.1.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 18, 2021 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package fastq parses fastq files.

This package uses the format described in: https://en.wikipedia.org/wiki/FASTQ_format

This package does not validate sequence and quality characters.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Fastq

type Fastq struct {
	Name     []byte // Entry name (without the '@')
	Sequence []byte // Sequence as received
	Quals    []byte // Qualities as received
}

Fastq is a single sequence in a fastq file.

func (*Fastq) MarshalText added in v0.1.17

func (f *Fastq) MarshalText() ([]byte, error)

MarshalText returns the textual representation of f in fastq format. Includes a trailing new line.

type Reader

type Reader struct {
	// contains filtered or unexported fields
}

A Reader reads sequences from a fastq stream.

func NewReader

func NewReader(r io.Reader) *Reader

NewReader returns a new fastq reader that reads from r.

func (*Reader) Read added in v0.1.10

func (r *Reader) Read() (*Fastq, error)

Read reads the next fastq entry from the reader. Returns a non-nil error if reading fails, or io.EOF if encountered end of file. When EOF is returned, no fastq is available.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL