mzidentml

Documentation

Index

• Variables
• type Identification
• type MzIdentML
  • func Read(reader io.Reader) (MzIdentML, error)
  • func (m *MzIdentML) Ident(i int) (Identification, error)
  • func (m *MzIdentML) NumIdents() int

Variables

var (
	ErrInvalidIdentIndex = errors.New("mzIdentML: invalid identification index")
)

Types

type Identification

type Identification struct {
	PepSeq        string
	PepID         string
	Charge        int
	ModMass       float64
	SpecID        string
	RetentionTime float64
	Cv            []cvParam
}

type MzIdentML

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

MzIdentML holds only the part of mzIdentML files in which we are interrested

func Read

func Read(reader io.Reader) (MzIdentML, error)

Read reads mzIdentML content from io.reader

func (*MzIdentML) Ident

func (m *MzIdentML) Ident(i int) (Identification, error)

Ident returns a spectrum identification from the mzIdentML file. Parameter i is the index of the identification to return. The index runs from 0 to NumIdents()-1

func (*MzIdentML) NumIdents

func (m *MzIdentML) NumIdents() int

NumIdents returns the total number of identifications in the mzIdentML file Note that for some spectra, multiple identifications may be present The identifications can be accessed using the Ident() method, which takes an index as argument. The index runs from 0 to NumIdents()-1