util

README

util

Some utilities

• LengthStats: caculating statistics of sequence length, including, Min, Max, Mean, Median, N50, L50, Q1, Q2, Q3, et al.

Documentation

Index

• type LengthStats
  • func NewLengthStats() *LengthStats
  • func (stats *LengthStats) Add(length uint64)
  • func (stats *LengthStats) Count() uint64
  • func (stats *LengthStats) L50() int
  • func (stats *LengthStats) LX(n float64) int
  • func (stats *LengthStats) Max() uint64
  • func (stats *LengthStats) Mean() float64
  • func (stats *LengthStats) Median() float64
  • func (stats *LengthStats) Min() uint64
  • func (stats *LengthStats) N50() uint64
  • func (stats *LengthStats) NX(n float64) uint64
  • func (stats *LengthStats) Percentile(percent float64) float64
  • func (stats *LengthStats) Q1() float64
  • func (stats *LengthStats) Q2() float64
  • func (stats *LengthStats) Q3() float64
  • func (stats *LengthStats) Sum() uint64

Types

type LengthStats

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

LengthStats accepts sequence lengths and calculate N50 et al..

func NewLengthStats

func NewLengthStats() *LengthStats

NewLengthStats initializes a LengthStats

func (*LengthStats) Add

func (stats *LengthStats) Add(length uint64)

Add adds a new length

func (*LengthStats) Count

func (stats *LengthStats) Count() uint64

Count returns number of elements

func (*LengthStats) L50

func (stats *LengthStats) L50() int

L50 returns L50

func (*LengthStats) LX

func (stats *LengthStats) LX(n float64) int

LX returns something like L50, where X could be a number in the range of [0, 100]

func (*LengthStats) Max

func (stats *LengthStats) Max() uint64

Max returns the maxinimum length

func (*LengthStats) Mean

func (stats *LengthStats) Mean() float64

Mean returns mean

func (*LengthStats) Median

func (stats *LengthStats) Median() float64

Median returns median

func (*LengthStats) Min

func (stats *LengthStats) Min() uint64

Min returns the minimum length

func (*LengthStats) N50

func (stats *LengthStats) N50() uint64

N50 returns N50

func (*LengthStats) NX

func (stats *LengthStats) NX(n float64) uint64

NX returns something like N50, where X could be a number in the range of [0, 100]

func (*LengthStats) Percentile

func (stats *LengthStats) Percentile(percent float64) float64

func (*LengthStats) Q1

func (stats *LengthStats) Q1() float64

Q1 returns Q1

func (*LengthStats) Q2

func (stats *LengthStats) Q2() float64

Q2 returns Q2

func (*LengthStats) Q3

func (stats *LengthStats) Q3() float64

Q3 returns Q3

func (*LengthStats) Sum

func (stats *LengthStats) Sum() uint64

Sum returns the length sum