Skip to content

flowmachine.features.subscriber.topup_amount

Source: flowmachine/features/subscriber/topup_amount.py

Class for calculating top-up recharge amount statistics.

Class TopUpAmount

TopUpAmount(start, stop, statistic: flowmachine.core.statistic_types.Statistic = <Statistic.AVG: 'avg'>, *, subscriber_identifier='msisdn', hours: Optional[Tuple[int, int]] = None, subscriber_subset=None)
Source: flowmachine/features/subscriber/topup_amount.py

This class calculates statistics associated with top-up recharge amounts.

Attributes

Parameters

  • start, stop: str

    iso-format start and stop datetimes

  • statistic: flowmachine.core.statistic_types.Statistic, default avg

    Defaults to avg, aggregation statistic over the durations.

  • hours: typing.Optional, default None

    Restrict the analysis to only a certain set of hours within each day.

  • subscriber_identifier: {'msisdn', 'imei'}, default 'msisdn'

    Either msisdn, or imei, the column that identifies the subscriber.

  • subscriber_subset: flowmachine.core.Table, flowmachine.core.Query, list, str, default None

    If provided, string or list of string which are msisdn or imeis to limit results to; or, a query or table which has a column with a name matching subscriber_identifier (typically, msisdn), to limit results to.

Examples

s = TopUpAmount("2016-01-01", "2016-01-08")
s.get_dataframe()
subscriber value bjY7mMXxE3zMoelO 5.580000 dqEQWNwAYEr4Mk3e 5.150000 BNxWrJ9mqMJ83Mzk 3.968000 346j7Nq67nvXZR0m 6.265455 7XebRKr35JMJnq8A 3.748750 ... ...

Methods

cache

cache
Source: flowmachine/core/query.py

Returns

  • bool

    True is caching is switched on.

column_names

column_names
Source: flowmachine/features/subscriber/topup_amount.py

Returns the column names.

Returns

  • list of str

    List of the column names of this query.

column_names_as_string_list

column_names_as_string_list
Source: flowmachine/core/query.py

Get the column names as a comma separated list

Returns

  • str

    Comma separated list of column names

dependencies

dependencies
Source: flowmachine/core/query.py

Returns

  • set

    The set of queries which this one is directly dependent on.

fully_qualified_table_name

fully_qualified_table_name
Source: flowmachine/core/query.py

Returns a unique fully qualified name for the query to be stored as under the cache schema, based on a hash of the parameters, class, and subqueries.

Returns

  • str

    String form of the table's fqn

index_cols

index_cols
Source: flowmachine/core/query.py

A list of columns to use as indexes when storing this query.

Returns

  • ixen: list

    By default, returns the location columns if they are present and self.spatial_unit is defined, and the subscriber column.

Examples
daily_location("2016-01-01").index_cols
[['name'], '"subscriber"']

is_stored

is_stored
Source: flowmachine/core/query.py

Returns

  • bool

    True if the table is stored, and False otherwise.

query_id

query_id
Source: flowmachine/core/query.py

Generate a uniquely identifying hash of this query, based on the parameters of it and the subqueries it is composed of.

Returns

  • str

    query_id hash string

query_state

query_state
Source: flowmachine/core/query.py

Return the current query state.

Returns

  • QueryState

    The current query state

query_state_str

query_state_str
Source: flowmachine/core/query.py

Return the current query state as a string

Returns

  • str

    The current query state. The possible values are the ones defined in flowmachine.core.query_state.QueryState.

table_name

table_name
Source: flowmachine/core/query.py

Returns a uniquename for the query to be stored as, based on a hash of the parameters, class, and subqueries.

Returns

  • str

    String form of the table's fqn