metrics

Documentation

Index

• func SitewiseBaseCounts(aln *nexus.Alignment, letters []byte) map[byte][]int
• func SitewiseEntropy(aln *nexus.Alignment, chars []byte) []float64
• func SitewiseGc(aln *nexus.Alignment) []float64
• type Metric
  • func (m Metric) String() string

Functions

func SitewiseBaseCounts

func SitewiseBaseCounts(aln *nexus.Alignment, letters []byte) map[byte][]int

SitewiseBaseCounts returns a 4xN array of base counts where N is the number of sites

func SitewiseEntropy

func SitewiseEntropy(aln *nexus.Alignment, chars []byte) []float64

func SitewiseGc

func SitewiseGc(aln *nexus.Alignment) []float64

Types

type Metric

type Metric int

Metric is an enum type denoting possible sitewise metrics to calculate

const (
	// Entropy is Shannon's entropy
	Entropy Metric = iota

	// GC is GC percentage
	GC

	// Multi is the multinomial measurement
	Multi
)

func (Metric) String

func (m Metric) String() string