Ridership annual summary endpoint improvements

[jaronheard]

Two requests:

• One thing that I didn't see - and maybe this exists - is that we should perform a check to see that we have two summaries per year. Right now the calculated statistics assume we have two, but I think would return an incorrect sum if we only have one.

• If you query this:
  http://service.civicpdx.org/transportation-systems/passenger-census/passenger-census-routes-annual/?route=15
  It should return an array containing the statistics for all of the years, rather than an aggregate for all years.

[bhgrant8]

@jaronheard on point 1:

Not yet deployed but added check to function after filtering by year:

Logic:

• counts number of unique dates
• divides 52 by this count
• uses this number as multiplier, instead of 26, to account for potential differences.

code:

try:
                            stops = stops.filter(summary_begin_date__year=this_year)
                            count = stops.values('summary_begin_date').distinct().count()
                            aggregator = 52/count
                            if stops:
                                annual_sums = stops.aggregate(sum_ons=Sum('ons')*aggregator, sum_offs=Sum('offs')*aggregator)
                                weekday_sums = stops.filter(service_key__icontains="W").aggregate(sum_ons=Sum('ons')*5*aggregator, sum_offs=Sum('offs')*5*aggregator)
                                saturday_sums = stops.filter(service_key__icontains="S").aggregate(sum_ons=Sum('ons')*aggregator, sum_offs=Sum('offs')*aggregator)
                                sunday_sums = stops.filter(service_key__icontains="U").aggregate(sum_ons=Sum('ons')*aggregator, sum_offs=Sum('offs')*aggregator)
                                serialized_stops = PassengerCensusSerializer(stops, many=True)
                                return Response({'route_number': this_route_number,
                                    'year': this_year,
                                    'total_stops': stops.count(),
                                    'annual_sums': annual_sums,
                                    'weekday_sums': weekday_sums,
                                    'saturday_sums': saturday_sums,
                                    'sunday_sums': sunday_sums,
                                    'num_of_yearly_census': count
                                    })
                            else:
...

[bhgrant8]

I have an idea of what to do on point 2

[jaronheard]

On point 1, that looks great 👍

…

On Fri, Jun 1, 2018 at 4:02 PM Brian Grant ***@***.***> wrote: I have an idea of what to do on point 2 — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#25 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AGvQX1JGsMQexLMWyR9tb3MbkXfrIEzOks5t4cftgaJpZM4USmMj> .

[bhgrant8]

ok so a new version of this has been deployed with this logicL

route is a required filter
year optional (if not specified returns all years)

returns:
grouped by year:

• year (extracted from summary_begin_date
• weekday ons, offs, stops * 5 days * 52/number of census
• saturday ons, offs, stops * 52/number of census
• sunday ons, offs, stops * 52/number of census
• number of census in the year

annual totals of each of these are then calculated as sums of the weekday, saturday, sunday amounts

routes that do not have either a saturday or sunday count for a given year are given 0 for values for day. additionally boolean fields are given for whether there was a saturday or sunday count for year.

Here is example response:
http://service.civicpdx.org/transportation-systems/passenger-census/passenger-census-routes-annual/?year=2001&route=15

[
  {
    "year": 2001,
    "weekday_sum_ons": 1755130,
    "weekday_sum_offs": 1714310,
    "weekday_total_stops": 33930,
    "saturday_sum_ons": 184990,
    "saturday_sum_offs": 176800,
    "saturday_total_stops": 33670,
    "sunday_sum_ons": 114062,
    "sunday_sum_offs": 111774,
    "sunday_total_stops": 34190,
    "num_of_yearly_census": 2,
    "sunday_census": true,
    "saturday_census": true,
    "annual_sum_ons": 2054182,
    "annual_sum_offs": 2002884,
    "total_annual_stops": 101790
  }
]

Note this does return a list, even with one response. LMK if it needs a separate retrieve

[BrianHGrant]

talking with @flamingveggies, story cards were referencing daily averages as well as totals. as such created two endpoints, average and totals. calculating this now per route and system.

updated endpoints routing as well:

• /transportation-systems/passenger-census/routes/annual/average/
• /transportation-systems/passenger-census/routes/annual/total/
• /transportation-systems/passenger-census/system/annual/average/
• /transportation-systems/passenger-census/system/annual/total/

removed stop counts as did not seem relavant

[bhgrant8]

will work on bus vs. rail. vs streetcar

[znmeb]

Here's the current route / stop table - data-science-pet-containers/examples/transportation-database/tm_route_stops.csv

I'm pretty sure the streetcar and MAX route numbers haven't changed so everything that isn't a streetcar or a MAX is a bus.