alignio

Documentation

Overview

Package alignio for reading and writing multiple sequence alignment files

Index

• type Reader
  • func NewReader(r seqio.Reader, m *multi.Multi) *Reader
  • func (r *Reader) Read() (*multi.Multi, error)
• type Writer
  • func NewWriter(w seqio.Writer) *Writer
  • func (w *Writer) Write(m *multi.Multi) (n int, err error)

Types

type Reader

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

Reader implements multiple sequence reading from a seqio.Reader.

func NewReader

func NewReader(r seqio.Reader, m *multi.Multi) *Reader

NewReader return a new Reader that will read sequences from r into m.

func (*Reader) Read

func (r *Reader) Read() (*multi.Multi, error)

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

type Writer

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

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 (w *Writer) Write(m *multi.Multi) (n int, err error)

Write a multi.Multi to the embedded seqio.Writer. Returns the number of bytes written and any error.