summarise

package

v0.22.1 Latest Latest Go to latest Published: Sep 2, 2026 License: MIT Imports: 5 Imported by: 0

Details

This section is empty.

This section is empty.

func PrintGroupBy(w io.Writer, groups []GroupCount, dimension string, topN int)

PrintGroupBy writes a ranked list of group counts to w.

func PrintSummary(w io.Writer, s Summary, topN int)

PrintSummary writes a formatted default summary report to w. topN controls how many top species and datasets are shown.

type GroupCount struct {
	Value string
	Count int
}

GroupCount holds a dimension value and the number of rows with that value.

func GroupBy(rows []query.ResultRow, dimension string) []GroupCount

GroupBy groups rows by the given dimension column and returns counts sorted descending by count, then alphabetically by value for ties.

type Summary struct {
	Total      int
	HQCount    int
	TopSpecies []GroupCount
	Datasets   []GroupCount
}

Summary holds aggregate statistics for a collection of genome rows.

func DefaultSummary(rows []query.ResultRow) Summary

DefaultSummary computes aggregate statistics over a slice of result rows.