reference.md

API Reference

Arrays

DimensionalData.AbstractBasicDimArray
AbstractDimArray
DimArray

Shorthand AbstractDimArray constructors:

Base.fill
Base.rand
Base.zeros
Base.ones

Functions for getting information from objects:

dims
refdims
metadata
name
otherdims
dimnum
hasdim

Multi-array datasets

AbstractDimStack
DimStack

DimTree

These objects and methods are still experimental and subject to breaking changes without breaking versions.

AbstractDimTree
DimTree
prune

Dimension generators

DimIndices
DimSelectors
DimPoints

Tables.jl/TableTraits.jl interface

DimensionalData.AbstractDimTable
DimTable

Group by methods

For transforming DimensionalData objects:

groupby
combine
DimensionalData.DimGroupByArray
Bins
ranges
intervals
CyclicBins
seasons
months
hours

Utility methods

For transforming DimensionalData objects:

set
rebuild
modify
@d
broadcast_dims
broadcast_dims!
mergedims
unmergedims
reorder

Global lookup strictness settings

Control how strict DimensionalData when comparing Lookups before doing broadcasts and matrix multipications.

In some cases (especially DimVector and small DimArray) checking lookup values match may be too costly compared to the operations. You can turn check the current setting and turn them on or off with these methods.

DimensionalData.strict_broadcast
DimensionalData.strict_broadcast!
DimensionalData.strict_matmul
DimensionalData.strict_matmul!

Base methods

Base.cat
Base.copy!
Base.eachslice

Most base methods work as expected, using Dimension wherever a dims keyword is used. They are not all specifically documented here.

Name

DimensionalData.AbstractName
DimensionalData.Name
DimensionalData.NoName

Internal interface

DimensionalData.DimArrayInterface
DimensionalData.DimStackInterface
DimensionalData.rebuild_from_arrays
DimensionalData.show_main
DimensionalData.show_after
DimensionalData.refdims_title