flowmachine.features.subscriber.interevent_period

Source: flowmachine/features/subscriber/interevent_period.py

Intervent period statistics, such as the average and standard deviation of the duration between calls.

Class IntereventPeriod

IntereventPeriod(start: str, stop: str, statistic: str = 'avg', *, time_resolution: str = 'hour', hours: Union[str, Tuple[int, int]] = 'all', tables: Union[str, List[str]] = 'all', subscriber_identifier: str = 'msisdn', subscriber_subset: Union[flowmachine.core.query.Query, NoneType] = None, direction: Union[str, flowmachine.features.utilities.direction_enum.Direction] = <Direction.OUT: 'out'>)

Source: flowmachine/features/subscriber/interevent_period.py

This class calculates intervent period statistics such as the average and standard deviation of the duration between calls and returns them as fractional time units.

Attributes

• cache

• column_names

• column_names_as_string_list

• dependencies

• fully_qualified_table_name

• index_cols

• is_stored

• query_id

• query_state

• query_state_str

• table_name

Parameters

• start: str

• stop: str

  iso-format start and stop datetimes

• hours: typing.Union[str, typing.Tuple[int, int]], default all

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

• time_resolution: str, default hour

  Temporal resolution to return results at, e.g. 'hour' for fractional hours.

• subscriber_identifier: str, default msisdn

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

• subscriber_subset: typing.Union[flowmachine.core.query.Query, NoneType], 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.

• direction: typing.Union[str, flowmachine.features.utilities.direction_enum.Direction], default out

  Whether to consider calls made, received, or both. Defaults to 'out'.

• tables: typing.Union[str, typing.List[str]], default all

  Can be a string of a single table (with the schema) or a list of these. The keyword all is to select all subscriber tables

• statistic: str, default avg

  Defaults to sum, aggregation statistic over the durations.

Examples

s = IntereventPeriod("2016-01-01", "2016-01-07")
s.get_dataframe()
           subscriber     value
0    038OVABN11Ak4W5P  4.956230
1    09NrjaNNvDanD8pk  3.877348
2    0ayZGYEQrqYlKw6g  4.034907
3    0DB8zw67E9mZAPK2  6.541865
4    0Gl95NRLjW2aw8pW  5.739062
..                ...       ...
495  ZQG8glazmxYa1K62  4.207696
496  Zv4W9eak2QN1M5A7  3.686201
497  zvaOknzKbEVD2eME  4.357561
498  Zy3DkbY7MDd6Er7l  4.550242
499  ZYPxqVGLzlQy6l7n  4.024503

[500 rows x 2 columns]

Methods

cache

cache

Source: flowmachine/core/query.py

Returns

• bool

  True is caching is switched on.

column_names

column_names

Source: flowmachine/features/subscriber/interevent_period.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