flowmachine.features.location.unmoving_at_reference_location_counts¶

Class UnmovingAtReferenceLocationCounts¶

UnmovingAtReferenceLocationCounts(unmoving_at_reference_location: flowmachine.features.subscriber.unmoving_at_reference_location.UnmovingAtReferenceLocation)

Source: flowmachine/features/location/unmoving_at_reference_location_counts.py

Per location counts of subscribers who were only seen at that location and did not move. Originally added as the FlowKit implementation of COVID-19 aggregate¹².

Parameters¶

unmoving_at_reference_location: flowmachine.features.subscriber.unmoving_at_reference_location.UnmovingAtReferenceLocation

Examples¶

UnmovingAtReferenceLocationCounts(UnmovingAtReferenceLocation(locations=UniqueLocations(SubscriberLocations("2016-01-01", "2016-01-02",spatial_unit=make_spatial_unit("admin", level=3))))).head()
          pcod  value
0  524 1 02 09      1
1  524 1 03 13      2
2  524 2 04 20      1
3  524 2 05 29      1
4  524 3 07 37      1

Methods¶

cache¶

cache

Source: flowmachine/core/query.py

Returns¶

bool

True is caching is switched on.

column_names¶

column_names

Source: flowmachine/features/location/unmoving_at_reference_location_counts.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