fastq

Documentation

Overview

Package to read and write FASTQ format files

Index

• type Reader
  • func NewReader(r io.Reader, t seqio.SequenceAppender) *Reader
  • func (self *Reader) Read() (s seq.Sequence, err error)
• type Writer
  • func NewWriter(w io.Writer) *Writer
  • func (self *Writer) Write(s seqio.Sequence) (n int, err error)

Types

type Reader

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

Fastq sequence format reader type.

func NewReader

func NewReader(r io.Reader, t seqio.SequenceAppender) *Reader

Returns a new fastq format reader using r.

func (*Reader) Read

func (self *Reader) Read() (s seq.Sequence, err error)

Read a single sequence and return it or an error. TODO: Does not read multi-line fastq.

type Writer

type Writer struct {
	QID bool // Include ID on +lines
	// contains filtered or unexported fields
}

Fastq sequence format writer type.

func NewWriter

func NewWriter(w io.Writer) *Writer

Returns a new fastq format writer using w.

func (*Writer) Write

func (self *Writer) Write(s seqio.Sequence) (n int, err error)

Write a single sequence and return the number of bytes written and any error.