frequency

Documentation

Index

• Constants
• func FrequencySetTimeKeyCount(fset FrequencySet) (statictimeseries.DataSeries, error)
• func FrequencySetTimeKeyCountTable(fset FrequencySet, interval timeutil.Interval, countColName string) (table.Table, error)
• func FrequencySetTimeKeyCountWriteXLSX(filename string, fset FrequencySet, interval timeutil.Interval, ...) error
• type FrequencySet
  • func FrequencySetDatetimeToQuarter(name string, fsetIn FrequencySet) (FrequencySet, error)
  • func NewFrequencySet(name string) FrequencySet
  • func NewFrequencySetWithData(name string, data map[string]map[string]int) FrequencySet
  • func (fset *FrequencySet) AddDateUidCount(dt time.Time, uid string, count int)
  • func (fset *FrequencySet) AddString(frequencyName, itemName string)
  • func (fset *FrequencySet) AddStringMore(frequencyName, uid string, count int)
  • func (fset *FrequencySet) LeafStats(name string) FrequencyStats
  • func (fset *FrequencySet) Names() []string
  • func (fset *FrequencySet) ToDataSeriesDistinct() (statictimeseries.DataSeries, error)
  • func (fset *FrequencySet) TotalCount() uint64
  • func (fset *FrequencySet) WriteXLSX(path, colName1, colName2, colNameCount string) error
• type FrequencySets
  • func NewFrequencySets() FrequencySets
  • func NewFrequencySetsCSVs(filenames []string, key1ColIdx, key2ColIdx, uidColIdx uint) (FrequencySets, table.Table, error)
  • func NewFrequencySetsTable(tbl table.Table, key1ColIdx, key2ColIdx, uidColIdx uint) (FrequencySets, error)
  • func (fsets *FrequencySets) Add(key1, key2, uid string, trimSpace bool)
  • func (fsets *FrequencySets) Counts() FrequencySetsCounts
  • func (fsets *FrequencySets) Flatten(name string) FrequencySet
• type FrequencySetsCounts
  • func NewFrequencySetsCounts(fsets FrequencySets) FrequencySetsCounts
  • func (fcounts *FrequencySetsCounts) Inflate()
• type FrequencyStats
  • func NewFrequencyStats(name string) FrequencyStats
  • func (fstats *FrequencyStats) Add(s string, count int)
  • func (fs *FrequencyStats) Inflate()
  • func (fs *FrequencyStats) ItemCounts(sortBy string) []maputil.Record
  • func (fs *FrequencyStats) ItemsSlice() []string
  • func (fs *FrequencyStats) ItemsSliceSorted() []string
  • func (fs *FrequencyStats) Stats() point.PointSet
  • func (fs *FrequencyStats) TotalCount() uint64
  • func (fs *FrequencyStats) WriteTableASCII(writer io.Writer, header []string, sortBy string, inclTotal bool)

Constants

const (
	SortNameAsc   = maputil.SortNameAsc
	SortNameDesc  = maputil.SortNameDesc
	SortValueAsc  = maputil.SortValueAsc
	SortValueDesc = maputil.SortValueDesc
)

Functions

func FrequencySetTimeKeyCount

func FrequencySetTimeKeyCount(fset FrequencySet) (statictimeseries.DataSeries, error)

FrequencySetTimeKeyCount returns a DataSeries when the first key is a RFC3339 time and a sum of items is desired per time.

func FrequencySetTimeKeyCountTable

func FrequencySetTimeKeyCountTable(fset FrequencySet, interval timeutil.Interval, countColName string) (table.Table, error)

func FrequencySetTimeKeyCountWriteXLSX

func FrequencySetTimeKeyCountWriteXLSX(filename string, fset FrequencySet, interval timeutil.Interval, countColName string) error

Types

type FrequencySet

type FrequencySet struct {
	Name         string
	FrequencyMap map[string]FrequencyStats
	KeyIsTime    bool
}

func FrequencySetDatetimeToQuarter

func FrequencySetDatetimeToQuarter(name string, fsetIn FrequencySet) (FrequencySet, error)

FrequencySetDatetimeToQuarterUnique converts a FrequencySet by date to one by quarter.s.

func NewFrequencySet

func NewFrequencySet(name string) FrequencySet

func NewFrequencySetWithData

func NewFrequencySetWithData(name string, data map[string]map[string]int) FrequencySet

func (*FrequencySet) AddDateUidCount

func (fset *FrequencySet) AddDateUidCount(dt time.Time, uid string, count int)

func (*FrequencySet) AddString

func (fset *FrequencySet) AddString(frequencyName, itemName string)

func (*FrequencySet) AddStringMore

func (fset *FrequencySet) AddStringMore(frequencyName, uid string, count int)

func (*FrequencySet) LeafStats

func (fset *FrequencySet) LeafStats(name string) FrequencyStats

func (*FrequencySet) Names

func (fset *FrequencySet) Names() []string

func (*FrequencySet) ToDataSeriesDistinct

func (fset *FrequencySet) ToDataSeriesDistinct() (statictimeseries.DataSeries, error)

func (*FrequencySet) TotalCount

func (fset *FrequencySet) TotalCount() uint64

func (*FrequencySet) WriteXLSX

func (fset *FrequencySet) WriteXLSX(path, colName1, colName2, colNameCount string) error

type FrequencySets

type FrequencySets struct {
	FrequencySetMap map[string]FrequencySet
}

func NewFrequencySets

func NewFrequencySets() FrequencySets

func NewFrequencySetsCSVs

func NewFrequencySetsCSVs(filenames []string, key1ColIdx, key2ColIdx, uidColIdx uint) (FrequencySets, table.Table, error)

NewFrequencySetsCSVs expects multiple files to have same columns.

func NewFrequencySetsTable

func NewFrequencySetsTable(tbl table.Table, key1ColIdx, key2ColIdx, uidColIdx uint) (FrequencySets, error)

func (*FrequencySets) Add

func (fsets *FrequencySets) Add(key1, key2, uid string, trimSpace bool)

func (*FrequencySets) Counts

func (fsets *FrequencySets) Counts() FrequencySetsCounts

func (*FrequencySets) Flatten

func (fsets *FrequencySets) Flatten(name string) FrequencySet

type FrequencySetsCounts

type FrequencySetsCounts struct {
	UidCounts     map[string]map[string]uint
	UidCountsKey1 map[string]uint
	UidCountsKey2 map[string]uint
	Key1Names     []string
	Key2Names     []string
}

FrequencySetsCounts returns UID counts. When used with NewFrequencySetsCSV(), it can provide a sanity check for raw record counts against aggregate query values, e.g. compare counts of raw records to GROUP BY counts.

func NewFrequencySetsCounts

func NewFrequencySetsCounts(fsets FrequencySets) FrequencySetsCounts

func (*FrequencySetsCounts) Inflate

func (fcounts *FrequencySetsCounts) Inflate()

type FrequencyStats

type FrequencyStats struct {
	Name        string
	Items       map[string]int
	Counts      map[string]int // how many items have counts.
	Percentages map[string]float64
	ItemCount   uint
	Sum         int
}

Frequency stats is used to count how many times an item appears and how many times number of appearances appear.

func NewFrequencyStats

func NewFrequencyStats(name string) FrequencyStats

func (*FrequencyStats) Add

func (fstats *FrequencyStats) Add(s string, count int)

func (*FrequencyStats) Inflate

func (fs *FrequencyStats) Inflate()

func (*FrequencyStats) ItemCounts

func (fs *FrequencyStats) ItemCounts(sortBy string) []maputil.Record

ItemCounts returns sorted item names and values.

func (*FrequencyStats) ItemsSlice

func (fs *FrequencyStats) ItemsSlice() []string

func (*FrequencyStats) ItemsSliceSorted

func (fs *FrequencyStats) ItemsSliceSorted() []string

func (*FrequencyStats) Stats

func (fs *FrequencyStats) Stats() point.PointSet

func (*FrequencyStats) TotalCount

func (fs *FrequencyStats) TotalCount() uint64

func (*FrequencyStats) WriteTableASCII

func (fs *FrequencyStats) WriteTableASCII(writer io.Writer, header []string, sortBy string, inclTotal bool)

WriteTable writes an ASCII Table. For CLI apps, pass `os.Stdout` for `io.Writer`.