flowmachine.features.subscriber.active_at_reference_location

Class ActiveAtReferenceLocation

ActiveAtReferenceLocation(subscriber_locations: flowmachine.features.subscriber.unique_locations.UniqueLocations, reference_locations: Union[flowmachine.features.subscriber.modal_location.ModalLocation, flowmachine.features.subscriber.most_frequent_location.MostFrequentLocation, flowmachine.features.subscriber.last_location.LastLocation, flowmachine.features.subscriber.first_location.FirstLocation])

Source: flowmachine/features/subscriber/active_at_reference_location.py

Determine whether a subscriber was active at their reference location.

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

• subscriber_locations: flowmachine.features.subscriber.unique_locations.UniqueLocations

  A subscriber locations object

• reference_locations: typing.Union[flowmachine.features.subscriber.modal_location.ModalLocation, flowmachine.features.subscriber.most_frequent_location.MostFrequentLocation, flowmachine.features.subscriber.last_location.LastLocation, flowmachine.features.subscriber.first_location.FirstLocation]

  A reference location to check for activity at.

Examples

ActiveAtReferenceLocation(subscriber_locations=UniqueLocations(SubscriberLocations("2016-01-01", "2016-01-02",
spatial_unit=make_spatial_unit("admin", level=3))),
reference_locations=daily_location("2016-01-03")).head()
         subscriber  value
0  038OVABN11Ak4W5P   True
1  09NrjaNNvDanD8pk  False
2  0ayZGYEQrqYlKw6g  False
3  0DB8zw67E9mZAPK2  False
4  0Gl95NRLjW2aw8pW   True

Methods

cache

cache

Source: flowmachine/core/query.py

Returns

• bool

  True is caching is switched on.

column_names

column_names

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