diff --git a/CHANGELOG.md b/CHANGELOG.md index 0ce97ac387d..e8a6c680c37 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ### Added - Added subscriber metrics, `ActiveAtReferenceLocation`, `Unmoving`, `UnmovingAtReferenceLocation` and `UniqueLocations` -- Added location metrics, `UniqueVisitorCounts`, `UnmovingAtReferenceLocationCounts`, `ActiveAtReferenceLocationCounts`, `UnmovingCount`, `TripsODMatrix`, `ConsecutiveTripsODMatrix` and their `Redacted*` equivalents +- Added location metrics and their `Redacted*` equivalents: + - `UniqueVisitorCounts` + - `UnmovingAtReferenceLocationCounts` ([COVID-19 equivalent](https://github.com/Flowminder/COVID-19/issues/8)) + - `ActiveAtReferenceLocationCounts` + - `UnmovingCount` ([COVID-19 equivalent](https://github.com/Flowminder/COVID-19/issues/10)) + - `TripsODMatrix` + - `ConsecutiveTripsODMatrix` ([COVID-19 equivalent](https://github.com/Flowminder/COVID-19/issues/9)) ### Changed diff --git a/flowmachine/flowmachine/features/location/consecutive_trips_od_matrix.py b/flowmachine/flowmachine/features/location/consecutive_trips_od_matrix.py index 223bbcada54..12792c8ae3b 100644 --- a/flowmachine/flowmachine/features/location/consecutive_trips_od_matrix.py +++ b/flowmachine/flowmachine/features/location/consecutive_trips_od_matrix.py @@ -15,6 +15,8 @@ class ConsecutiveTripsODMatrix(FlowLike, Query): """ An object which represents a count of subscriber who made consecutive visits between locations. + Originally added as the FlowKit implementation of COVID-19 aggregate[1]_. + Parameters ---------- subscriber_locations : SubscriberLocations @@ -29,6 +31,10 @@ class ConsecutiveTripsODMatrix(FlowLike, Query): 3 0RIMKYtf wQ7i3Z8n 1 4 0RIMKYtf WET2L101 2 + References + ---------- + .. [1] https://github.com/Flowminder/COVID-19/issues/9 + """ def __init__(self, subscriber_locations: SubscriberLocations): diff --git a/flowmachine/flowmachine/features/location/unmoving_at_reference_location_counts.py b/flowmachine/flowmachine/features/location/unmoving_at_reference_location_counts.py index 24a0a4ea35a..663de71983e 100644 --- a/flowmachine/flowmachine/features/location/unmoving_at_reference_location_counts.py +++ b/flowmachine/flowmachine/features/location/unmoving_at_reference_location_counts.py @@ -16,6 +16,8 @@ class UnmovingAtReferenceLocationCounts(GeoDataMixin, Query): """ 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[1]_. + Parameters ---------- unmoving_at_reference_location : UnmovingAtReferenceLocation @@ -29,6 +31,10 @@ class UnmovingAtReferenceLocationCounts(GeoDataMixin, Query): 2 524 2 04 20 1 3 524 2 05 29 1 4 524 3 07 37 1 + + References + ---------- + .. [1] https://github.com/Flowminder/COVID-19/issues/8 """ def __init__(self, unmoving_at_reference_location: UnmovingAtReferenceLocation): diff --git a/flowmachine/flowmachine/features/location/unmoving_counts.py b/flowmachine/flowmachine/features/location/unmoving_counts.py index 8724a703866..a38db2a7bb7 100644 --- a/flowmachine/flowmachine/features/location/unmoving_counts.py +++ b/flowmachine/flowmachine/features/location/unmoving_counts.py @@ -13,6 +13,8 @@ class UnmovingCounts(GeoDataMixin, Query): """ 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[1]_. + Parameters ---------- unmoving : Unmoving @@ -26,6 +28,10 @@ class UnmovingCounts(GeoDataMixin, Query): 2 524 2 04 20 1 3 524 2 05 29 1 4 524 3 07 37 1 + + References + ---------- + .. [1] https://github.com/Flowminder/COVID-19/issues/10 """ def __init__(self, unmoving: Unmoving): diff --git a/flowmachine/flowmachine/features/subscriber/unique_locations.py b/flowmachine/flowmachine/features/subscriber/unique_locations.py index 98c2d04a767..0add1b9ecd0 100644 --- a/flowmachine/flowmachine/features/subscriber/unique_locations.py +++ b/flowmachine/flowmachine/features/subscriber/unique_locations.py @@ -13,6 +13,7 @@ class UniqueLocations(SubscriberFeature): """ The unique locations a subscriber has visited. + Added to support FlowKit implementation of COVID-19 aggregates[1]_. Parameters ---------- @@ -28,6 +29,10 @@ class UniqueLocations(SubscriberFeature): 2 038OVABN11Ak4W5P 524 4 12 62 3 038OVABN11Ak4W5P 524 4 12 65 4 09NrjaNNvDanD8pk 524 2 04 20 + + References + ---------- + .. [1] https://github.com/Flowminder/COVID-19/issues/12 """ def __init__(