Documentation
¶
Overview ¶
the reporter package computes multiple statistics that quantify the quality of a collection of contigs
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type IntHeap ¶
type IntHeap []int
An IntHeap is a max-heap of ints
type Report ¶
type Report struct {
// AssemblyName is the name of the assembly the Report represents
AssemblyName string
// Processed is an indicator that represents whether the reporter process has been executed
Processed bool
// N50 score of the assembly
N50 int32
// L50 score of the assembly
L50 int32
// contains filtered or unexported fields
}
Report represents the struct that holds the stats that characterize an assembly
func (*Report) GetAssemblyName ¶
GetAssemblyName returns the reporter assembly name
func (*Report) GetL50 ¶
GetL50 returns the computed L50 value stored on the Report. An error is returned if the reporter process has not been executed
type Reporter ¶
type Reporter interface {
// Process constructs the Report for the given assembler results
Process() error
// GetL50 returns the computed L50 value stored on the Report. An error is returned if the reporter process has not been executed
GetL50() (int32, error)
// GetN50 returns the N50 score of the Report contigs. An error is returned if the reporter process has not been executed
GetN50() (int32, error)
// GetAssemblyName returns the name of the reporter
GetAssemblyName() string
}
Reporter defines the interface of the reporter that constructs stats' of the assemblies
Source Files
Click to show internal directories.
Click to hide internal directories.