flowmachine.features.subscriber.contact_balance¶
Source: flowmachine/features/subscriber/contact_balance.py
The total number of events that a subscriber interacts with a counterpart, and the proportion of events that a given contact participates out of the subscriber's total event count.
Class ContactBalance¶
ContactBalance(start, stop, *, hours: Optional[Tuple[int, int]] = None, tables='all', subscriber_identifier='msisdn', direction: Union[str, flowmachine.features.utilities.direction_enum.Direction] = <Direction.BOTH: 'both'>, exclude_self_calls=True, subscriber_subset=None)
This class calculates the total number of events that a subscriber interacts with a counterpart, and the proportion of events that a given contact participates out of the subscriber's total event count. This can be used to calculate a subscriber's contact network graph and the respective weighted edges for each contact.
Attributes¶
Parameters¶
-
start
,stop
:str
iso-format start and stop datetimes
-
hours
:typing.Optional
, defaultNone
Restrict the analysis to only a certain set of hours within each day.
-
tables
:str
, default'all'
-
exclude_self_calls
:bool
, defaultTrue
Set to false to include calls a subscriber made to themself
-
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
, defaultNone
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
, defaultboth
Event direction to include in computation. This can be outgoing ('out'), incoming ('in'), or both ('both').
Examples¶
ContactBalance('2016-01-01', '2016-01-07')
Methods¶
counterparts_subset¶
counterparts_subset(self, include_subscribers=False)
Returns the subset of counterparts. In some cases, we are interested in obtaining information about the subset of subscribers contacts.
This method also allows one to get the subset of counterparts together with subscribers by turning the include_subscribers
flag to True
.
Parameters¶
-
include_subscribers
:bool
, defaultTrue
Wether to include the list of subscribers in the subset as well.
cache¶
cache
Returns¶
-
bool
True is caching is switched on.
column_names¶
column_names
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
Get the column names as a comma separated list
Returns¶
-
str
Comma separated list of column names
dependencies¶
dependencies
Returns¶
-
set
The set of queries which this one is directly dependent on.
fully_qualified_table_name¶
fully_qualified_table_name
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
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
Returns¶
-
bool
True if the table is stored, and False otherwise.
query_id¶
query_id
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
Return the current query state.
Returns¶
-
QueryState
The current query state
query_state_str¶
query_state_str
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
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