groupby

Documentation

Index

• type Config
  • func NewConfig(configFns []ConfigFunc) Config
• type ConfigFunc
  • func Columns(columns ...string) ConfigFunc
  • func Null(b bool) ConfigFunc

Types

type Config

type Config struct {
	Columns     []string
	GroupByNull bool
}

Config holds configuration for group by operations on QFrames. It should be considered a private implementation detail and should never be referenced or used directly outside of the QFrame code. To manipulate it use the functions returning ConfigFunc below.

func NewConfig

func NewConfig(configFns []ConfigFunc) Config

NewConfig creates a new Config object. This function should never be called from outside QFrame.

type ConfigFunc

type ConfigFunc func(c *Config)

ConfigFunc is a function that operates on a Config object.

func Columns

func Columns(columns ...string) ConfigFunc

Columns sets the columns by which the data should be grouped. Leaving this configuration option out will group on all columns in the QFrame.

The order of columns does not matter from a functional point of view but it may impact execution time a bit. For optimal performance order columns according to type with the following priority: 1. int 2. float 3. enum/bool 4. string

func Null

func Null(b bool) ConfigFunc

Null configures if Na/nulls should be grouped together or not. Default is false (eg. don't group null/NaN).