alignio

Documentation

Overview

Package for reading and writing multiple sequence alignment files

Index

• type Reader
  • func NewReader(r seqio.Reader) *Reader
  • func (self *Reader) Read() (a seq.Alignment, err error)
• type Writer
  • func NewWriter(w seqio.Writer) *Writer
  • func (self *Writer) Write(a seq.Alignment) (n int, err error)

Types

type Reader

type Reader struct {
	seqio.Reader
}

Reader implements multiple sequence reading from a seqio.Reader.

func NewReader

func NewReader(r seqio.Reader) *Reader

Return a new Reader.

func (*Reader) Read

func (self *Reader) Read() (a seq.Alignment, err error)

Read the contents of the embedded seqio.Reader into a seq.Alignment. Returns the Alignment, or nil and an error if an error occurs.

type Writer

type Writer struct {
	seqio.Writer
}

Writer implements multiple sequence writing to a seqio.Writer.

func NewWriter

func NewWriter(w seqio.Writer) *Writer

Return a new Writer.

func (*Writer) Write

func (self *Writer) Write(a seq.Alignment) (n int, err error)

Write a seq.Alignment to the embedded seqio.Reader. Returns the number of bytes written and any error.