Skip to content

flowmachine.features.subscriber.distance_counterparts

Source: flowmachine/features/subscriber/distance_counterparts.py

Calculate metrics related with distance between caller and her/his counterparts.

Class DistanceCounterparts

DistanceCounterparts(start, stop, statistic: Union[flowmachine.core.statistic_types.Statistic, str] = <Statistic.AVG: 'avg'>, *, hours: Optional[Tuple[int, int]] = None, tables='all', direction: Union[str, flowmachine.features.utilities.direction_enum.Direction] = <Direction.BOTH: 'both'>, subscriber_subset=None, exclude_self_calls=True)
Source: flowmachine/features/subscriber/distance_counterparts.py

This class returns metrics related with the distance between event initiator and her/his counterparts. It assumes that the ID column uniquely identifies the event initiator and their counterparts' event. Choose only tables for which this assumption is true. In some cases, asynchronous communication like SMS might not be tagged with an ID that allows one to recover the counterpart event. Distances are measured in km.

Attributes

Parameters

  • start, stop: str

    iso-format start and stop datetimes

  • hours: typing.Optional, default None

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

  • tables: str, default 'all'.

    The table must have a msisdn_counterpart column.

  • 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.

  • statistic: typing.Union, default avg

  • exclude_self_calls: bool, default True

    Set to false to include calls a subscriber made to themself Defaults to sum, aggregation statistic over the durations.

Examples

s = DistanceCounterparts("2016-01-01", "2016-01-07", statistic="avg")
s.get_dataframe()
subscriber distance_avg 038OVABN11Ak4W5P 272.167815 09NrjaNNvDanD8pk 241.290233 0ayZGYEQrqYlKw6g 218.161568 0DB8zw67E9mZAPK2 228.235324 0Gl95NRLjW2aw8pW 189.008980 ... ...

Methods

cache

cache
Source: flowmachine/core/query.py

Returns

  • bool

    True is caching is switched on.

column_names

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

Returns the column names.

Returns

  • typing.List

    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