coda
v0.3.0

View Source Coda.Behaviour.Analytics behaviour (coda v0.3.0)

Behaviour of facets analytics

Summary

Types

dataframe()
digest()
facet_type()
facets()
facets_analytics_response()
options()
scrobbles()
year_count()

Callbacks

dataframe(options)
digest(dataframe)
sample_albums(dataframe, options)
sample_artists(dataframe, options)
sample_tracks(dataframe, options)
top_albums(dataframe, options)
top_artists(dataframe, options)
top_tracks(dataframe, options)

Types

Link to this type

dataframe()

View Source 
@type dataframe() :: Explorer.DataFrame.t()
Link to this type

digest()

View Source 
@type digest() :: %{
  counts: integer(),
  max_year: integer(),
  min_year: integer(),
  n_albums: integer(),
  n_artists: integer(),
  n_tracks: integer(),
  n_years: integer(),
  years_digest: [year_count()]
}
Link to this type

facet_type()

View Source 
@type facet_type() ::
  Explorer.DataFrame.column_name() | Explorer.DataFrame.column_names()
Link to this type

facets()

View Source 
@type facets() :: Explorer.DataFrame.t()
Link to this type

facets_analytics_response()

View Source 
@type facets_analytics_response() :: {facets(), facet_type(), scrobbles()}
Link to this type

options()

View Source 
@type options() :: Keyword.t()
Link to this type

scrobbles()

View Source 
@type scrobbles() :: Explorer.DataFrame.t()
Link to this type

year_count()

View Source 
@type year_count() :: %{year: integer(), counts: integer()}

Callbacks

Link to this callback

dataframe(options)

View Source 
@callback dataframe(options()) :: {:ok, dataframe()} | {:error, term()}
Link to this callback

digest(dataframe)

View Source 
@callback digest(dataframe()) :: digest()
Link to this callback

sample_albums(dataframe, options)

View Source 
@callback sample_albums(dataframe(), options()) :: facets_analytics_response()
Link to this callback

sample_artists(dataframe, options)

View Source 
@callback sample_artists(dataframe(), options()) :: facets_analytics_response()
Link to this callback

sample_tracks(dataframe, options)

View Source 
@callback sample_tracks(dataframe(), options()) :: facets_analytics_response()
Link to this callback

top_albums(dataframe, options)

View Source 
@callback top_albums(dataframe(), options()) :: facets_analytics_response()
Link to this callback

top_artists(dataframe, options)

View Source 
@callback top_artists(dataframe(), options()) :: facets_analytics_response()
Link to this callback

top_tracks(dataframe, options)

View Source 
@callback top_tracks(dataframe(), options()) :: facets_analytics_response()