Skip to content

flowmachine.features.subscriber.pareto_interactions

Source: flowmachine/features/subscriber/pareto_interactions.py

This class calculates the Pareto proportion for a subscriber's interactions - that fraction of their contacts who account for 80% of their interactions.

Class ParetoInteractions

ParetoInteractions(start, stop, proportion=0.8, *, direction: Union[str, flowmachine.features.utilities.direction_enum.Direction] = <Direction.BOTH: 'both'>, tables='all', subscriber_identifier='msisdn', hours: Union[Tuple[int, int], NoneType] = None, exclude_self_calls=False, subscriber_subset=None)
Source: flowmachine/features/subscriber/pareto_interactions.py

Calculates the proportion of a subscriber's contacts who account for some proportion of their interactions, ala the Pareto Principle. Returns a two columns, a subscriber, pareto - the proportion of that subscribers contacts who account for the requested proportion (0.8, by default) of their interactions in this time period.

Attributes

Parameters

  • start, stop: str

    iso-format start and stop datetimes

  • hours: typing.Union[typing.Tuple[int, int], NoneType], default None

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

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

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

  • exclude_self_calls: bool, default True

    Set to false to include calls a subscriber made to themself

  • table: str, default 'all'

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

  • proportion: float

    proportion to track below

Examples

p = ParetoInteractions("2016-01-01", "2016-01-02")
p.get_dataframe()
subscriber value 0 038OVABN11Ak4W5P 1.0 1 09NrjaNNvDanD8pk 1.0 2 0ayZGYEQrqYlKw6g 1.0 3 0DB8zw67E9mZAPK2 1.0 4 0Gl95NRLjW2aw8pW 1.0 ... ...

Methods

cache

cache
Source: flowmachine/core/query.py

Returns

  • bool

    True is caching is switched on.

column_names

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

Returns the column names.

Returns

  • typing.List[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