flowmachine.features.subscriber.new_subscribers

Source: flowmachine/features/subscriber/new_subscribers.py

Generates a list of new subscribers who are present in the dataset in a given time period, but absent from the dataset in a subsequent comparison time period.

Class NewSubscribers

NewSubscribers(*, unique_subscribers_bench_mark: flowmachine.features.utilities.sets.UniqueSubscribers, unique_subscribers_focal: flowmachine.features.utilities.sets.UniqueSubscribers)

Source: flowmachine/features/subscriber/new_subscribers.py

Find a list of all new subscribers who were not seen within a certain date range.

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

• unique_subscribers_benchmark: UniqueSubscribers

  Query returning the unique subscribers in the benchmark period

• unique_subscribers_focal: flowmachine.features.utilities.sets.UniqueSubscribers

  Query returning the unique subscribers in the focal period

Examples

>>>newbies = NewSubscribers(unique_subscribers_bench_mark=UniqueSubscribers('2016-01-01','2016-01-07'), unique_subscribers_focal=UniqueSubscribers('2016-03-01', '2016-03-07'))
subscriber | location
---------------
  A  |  cellX
  B  |  cellY
  Z  |  cellW

Methods

cache

cache

Source: flowmachine/core/query.py

Returns

• bool

  True is caching is switched on.

column_names

column_names

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