-
Notifications
You must be signed in to change notification settings - Fork 7
/
dashboard_dev.py
555 lines (440 loc) · 23.1 KB
/
dashboard_dev.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
import credentials as creds
import pandas as pd
import numpy as np
from datetime import date, datetime
import time
import warnings
warnings.filterwarnings('ignore')
########## DASHBOARD ##########
#### QUANTITY ####
#### Step 1. Load Published Data Asset Inventory
# Local Law 251 of 2017: Published Data Asset Inventory
# https://data.cityofnewyork.us/City-Government/Local-Law-251-of-2017-Published-Data-Asset-Invento/5tqd-u88y
public_df = creds.call_socrata_api('5tqd-u88y')
public_cols = [
'datasetinformation_agency',
'name',
'uid',
'url',
'update_datemadepublic',
'update_automation',
'update_updatefrequency',
'last_data_updated_date',
'type',
'row_count',
'derived_view',
'parent_uid'
]
public_df = public_df[public_cols]
#### Step 2. Get dates of the data updates
# get the dates each of datasets has been updated
dates_df = public_df[public_df.uid.isin(['5tqd-u88y','qj2z-ibhs'])]\
[['uid', 'last_data_updated_date']]
dates_df['last_data_updated_date'] = pd.to_datetime(dates_df.last_data_updated_date,
errors='coerce')\
.dt.strftime("%Y-%m-%d")
today_df = pd.DataFrame({'uid':['NA'],
'last_data_updated_date':[date.today().strftime("%Y-%m-%d")],
'Source':['1. Dashboard']})
dates_df.loc[dates_df.uid=='5tqd-u88y','Source'] = '2. Published Asset Inventory'
dates_df.loc[dates_df.uid=='qj2z-ibhs','Source'] = '3. Open Plan Tracker'
dates_df = dates_df.append(today_df)
dates_df.reset_index(inplace=True, drop=True)
dates_df = dates_df[['Source', 'last_data_updated_date']]
dates_df.rename(columns={'last_data_updated_date':'Updated on'},inplace=True)
#### Step 3. Filter out assets
# Create merged_filter, the dataframe that has only assets defined as datasets
# ZF approved the list
print("Available asset types in the public AI:")
print(public_df['type'].value_counts(dropna=False).sort_index())
print()
dataset_filter_list = ['dataset','filter','map']
public_filtered_df = public_df[public_df['type'].isin(dataset_filter_list)]
## remove derived assets if parent asset is public
# get parent ids for derived assets
parent_uids = public_filtered_df[public_filtered_df['derived_view']==True]['parent_uid']
# get ids for the assets derived from public assets
exc_parent_uids = public_filtered_df[public_filtered_df['uid'].isin(parent_uids)]['uid']
# remove derived assets if parent asset is public
public_filtered_df = public_filtered_df[~public_filtered_df['parent_uid'].isin(exc_parent_uids)]
#### Step 4. Create one main dataset-level dataframe
# fix one date typo
public_filtered_df.loc[public_filtered_df['update_datemadepublic']=='August 9, 2-019',\
'update_datemadepublic'] = 'August 9, 2019'
# convert to date
public_filtered_df['update_datemadepublic'] = pd.to_datetime(
pd.to_datetime(public_filtered_df['update_datemadepublic'],
errors='coerce')\
.dt.strftime('%m/%d/%Y'), format=('%m/%d/%Y'))
public_filtered_df['last_data_updated_date'] = pd.to_datetime(
pd.to_datetime(public_filtered_df['last_data_updated_date'])\
.dt.strftime('%m/%d/%Y'))
# if agency is missing, create NA category
public_filtered_df['datasetinformation_agency'] = public_filtered_df['datasetinformation_agency'].fillna('Not filled out')
public_filtered_df.loc[public_filtered_df['datasetinformation_agency']=='','datasetinformation_agency'] = 'Not filled out'
# keep only required columns
keep_quant_cols=[
'uid',
'datasetinformation_agency',
'name',
'url',
'type',
'update_datemadepublic',
'last_data_updated_date',
'row_count'
]
quantity_dataset_df = public_filtered_df[keep_quant_cols]
#### Step 5. Create one main agency-level dataframe
quantity_agency_df = quantity_dataset_df.groupby(['datasetinformation_agency'])\
.agg({'uid':'size','row_count':'sum'})\
.reset_index()\
.rename(columns={'uid':'numdatasets'})
#### QUALITY (Data Freshness) ####
#### Step 1. Build baseline dataset
print("List of available update frequencies:")
print(public_filtered_df['update_updatefrequency'].value_counts(dropna=False).sort_index())
print()
update_values_avail = set(public_filtered_df['update_updatefrequency'].unique())
# list of included frequency updates
update_values_used = ['Daily', 'Annually', 'Biannually ',
'Quarterly', 'Monthly', 'Weekly', '2 to 4 times per year',
'Weekdays', 'Every four years', 'Biweekly ', 'Triannually',
'Several times per day', 'Hourly']
# identify new update frequency values
print("Not used update frequencies:")
print(update_values_avail.difference(update_values_used))
print()
freshness_df = public_filtered_df[[
'datasetinformation_agency',
'name',
'uid',
'update_updatefrequency',
'url',
'update_datemadepublic',
'last_data_updated_date',
'update_automation']]
# Remove datasets with update frequencies for which we cannot determine freshness
freshness_df = freshness_df[(freshness_df['update_updatefrequency'].isin(update_values_used)) &\
~freshness_df['update_updatefrequency'].isna()]\
.reset_index(drop=True)
def assign_dataframe_statuses(data):
"""
Determines if the data has been updated on time
The list of update frequency needs to be updated manually with new values
"""
df = data.copy()
# some values have spaces
df['update_updatefrequency'] = df['update_updatefrequency'].str.strip()
# assign time by update frequency
status_conditions = [
(df['update_updatefrequency']=='Annually'),
(df['update_updatefrequency']=='Monthly'),
(df['update_updatefrequency']=='Quarterly'),
(df['update_updatefrequency']=='Daily'),
(df['update_updatefrequency']=='Biannually'),
(df['update_updatefrequency']=='Weekly'),
(df['update_updatefrequency']=='Triannually'),
(df['update_updatefrequency']=='Weekdays'),
(df['update_updatefrequency']=='2 to 4 times per year'),
(df['update_updatefrequency']=='Biweekly'),
(df['update_updatefrequency']=='Several times per day'),
(df['update_updatefrequency']=='Hourly'),
(df['update_updatefrequency']=='Every four years')
]
status_choices = [
pd.Timedelta('365 days'),
pd.Timedelta('31 days'),
pd.Timedelta('92 days'),
pd.Timedelta('25 hours'),
pd.Timedelta('182 days'),
pd.Timedelta('7 days'),
pd.Timedelta('122 days'),
pd.Timedelta('5 days'),
pd.Timedelta('182 days'),
pd.Timedelta('4 days'),
pd.Timedelta('25 hours'),
pd.Timedelta('25 hours'),
pd.Timedelta('1460 days')
]
df['update_threshold'] = np.select(status_conditions, status_choices, default=pd.Timedelta('50000 days'))
# calculate when asset should have been last updated
df['last_updated_ago'] = pd.to_datetime(date.today()) - df['last_data_updated_date']
# assign status "updated on time" to datasets updated on time and automated datasets
df['fresh'] = np.where(((df['last_updated_ago']<df['update_threshold']) | (df['update_automation']=='Yes')),'Yes','No')
df.drop(columns=['update_threshold'],inplace=True)
return df
freshness_df = assign_dataframe_statuses(freshness_df)
keep_fresh_cols = [
'uid',
'datasetinformation_agency',
'name',
'url',
'update_automation',
'update_updatefrequency',
'last_data_updated_date',
'fresh'
]
freshness_dataset_df = freshness_df[keep_fresh_cols]
#### Step 2. Calculate average data freshness by agency
# get the count of fresh dataset by agency
fresh_count_df = freshness_df[freshness_df['fresh']=='Yes'].groupby(['datasetinformation_agency'])\
.size()\
.reset_index()\
.rename(columns={0:'fresh_count'})
# get the total count of datasets by agency (excluding historical and as needed)
freshness_agency_df = freshness_df.groupby(['datasetinformation_agency'])\
.size()\
.reset_index()\
.rename(columns={0:'total_auto_count'})\
.merge(fresh_count_df, on='datasetinformation_agency',how='left')
# calculate percent freshly updated
freshness_agency_df['fresh_pct'] = freshness_agency_df['fresh_count'].fillna(0) / \
freshness_agency_df['total_auto_count']
#### COMPLIANCE ####
#### Step 1. Build baseline dataset
# NYC Open Data Release Tracker
# https://data.cityofnewyork.us/City-Government/NYC-Open-Data-Release-Tracker/qj2z-ibhs
tracker_df = creds.call_socrata_api('qj2z-ibhs')
print("Release status values:")
print(tracker_df['release_status'].value_counts(dropna=False).sort_index())
print()
# exclude Removed from the plan and Removed from the portal,
release_status_filter = [
'Released',
'Scheduled for release',
'Under Review'
]
tracker_df = tracker_df[tracker_df['release_status'].isin(release_status_filter)]
# convert dates to dates
tracker_df['original_plan_date'] = pd.to_datetime(tracker_df['original_plan_date'])
tracker_df['latest_plan_date'] = pd.to_datetime(tracker_df['latest_plan_date'])
tracker_df['release_date'] = pd.to_datetime(tracker_df['release_date'])
# number of days between release and planned date
tracker_df['plan_to_release'] = (tracker_df['release_date'] - tracker_df['latest_plan_date']).dt.days
# apply grace period for release date
grace_period_days = 14
today = date.today()
# create a check if released on time
tracker_df['within_grace_period'] = np.where((tracker_df['plan_to_release'] < grace_period_days), 'Yes', 'No')
tracker_df['within_grace_period_num'] = tracker_df['plan_to_release'] < grace_period_days
# subset datasets that were supposed to be released in the last 12 months
tracker_df['last_12_months'] = ((pd.to_datetime(today) - tracker_df['latest_plan_date']).dt.days < 365) & \
(tracker_df['latest_plan_date'] <= pd.to_datetime(today))
tracker_df['url'] = tracker_df['url1'].apply(lambda x: list(x.values())[0] \
if type(x) is dict else 'NA')
tracker_df.drop(columns=['url1'],inplace=True)
# drop duplicates for released datasets
# keep the one with the oldest release date
tracker_df = tracker_df[~tracker_df.u_id.isna()]\
.sort_values(by='release_date')\
.drop_duplicates(subset=['u_id'], keep='first')\
.append(tracker_df[tracker_df['u_id'].isna()])
tracker_12mo_df = tracker_df[tracker_df['last_12_months']]
tracker_12mo_df['latest_plan_date'] = tracker_12mo_df['latest_plan_date'].dt.strftime("%Y-%m-%d")
tracker_12mo_df['release_date'] = tracker_12mo_df['release_date'].dt.strftime("%Y-%m-%d")
#### Step 2. Build dataset-level dataset
keep_tracker_cols = [
'u_id',
'agency',
'dataset',
'dataset_description',
'latest_plan_date',
'release_status',
'release_date',
'within_grace_period',
'within_grace_period_num',
'url'
]
tracker_12mo_dataset_df = tracker_12mo_df[keep_tracker_cols]
# append type and agency from public inventory
tracker_12mo_dataset_df = tracker_12mo_dataset_df.merge(public_df[['uid','type','datasetinformation_agency']],
left_on='u_id',
right_on='uid',
how='left')
# update agency name to match public inventory (can only be done for already published datasets)
tracker_12mo_dataset_df['datasetinformation_agency'] = np.where((tracker_12mo_dataset_df.release_status=='Released') & \
~tracker_12mo_dataset_df['datasetinformation_agency'].isna(),
tracker_12mo_dataset_df['datasetinformation_agency'],
tracker_12mo_dataset_df['agency'])
# exclude assets that are not datasets, filters and gis maps
# keeps assets scheduled for release with type NA
tracker_12mo_dataset_df = tracker_12mo_dataset_df[tracker_12mo_dataset_df['u_id'].isin(quantity_dataset_df['uid']) | \
(tracker_12mo_dataset_df['release_status']=='Scheduled for release')]
tracker_12mo_dataset_df.drop(columns=['u_id','agency'],inplace=True)
#### Step 3. Build agency-level dataset
# count number of overdue for release datasets
agency_overdue_df = tracker_12mo_dataset_df[tracker_12mo_dataset_df['release_status']=='Scheduled for release']\
.groupby(['datasetinformation_agency']).size().reset_index()\
.rename(columns={0:'overdue_datasets'})
tracker_12mo_agency_df = tracker_12mo_dataset_df.groupby(['datasetinformation_agency'])\
.agg({'datasetinformation_agency':'size',
'within_grace_period_num':'sum'})\
.rename(columns={'datasetinformation_agency':'tracker_dataset_count',
'within_grace_period_num':'tracker_count_ontime'})\
.merge(agency_overdue_df, on='datasetinformation_agency', how='left')\
.reset_index(drop=True)\
.fillna(0)
# calculate percent released on time
tracker_12mo_agency_df['pct_ontime'] = tracker_12mo_agency_df['tracker_count_ontime'].fillna(0)/tracker_12mo_agency_df['tracker_dataset_count']
#### DASHBOARD ####
#### Step 1. Get citywide metrics
# total number of rows
cw_numrows = quantity_agency_df['row_count'].sum()
# total number of datasets
cw_numdatasets = quantity_agency_df['numdatasets'].sum()
# percent updated on time
cw_freshness = freshness_dataset_df[freshness_dataset_df['fresh']=='Yes'].shape[0]/\
freshness_df.shape[0]
# percent released on time
cw_compliance = tracker_12mo_dataset_df['within_grace_period_num'].sum()/ \
tracker_12mo_dataset_df.shape[0]
# number of assets that were supposed to be released but were not as of today
cw_overdue = tracker_12mo_dataset_df[tracker_12mo_dataset_df['release_status']=='Scheduled for release'].shape[0]
citywide_df = pd.DataFrame([['Citywide',
cw_numrows,
cw_numdatasets,
cw_freshness,
cw_compliance,
cw_overdue]],
columns=['Scope',
'Number of rows',
'Number of datasets',
'Percent of datasets updated on time',
'Percent of planned releases released on time within last 12 months',
'Number of overdue for release datasets'])
#### Step 2. Build complete agency-level dataset
all_agency_df = quantity_agency_df.merge(freshness_agency_df,
on='datasetinformation_agency',
how='outer')\
.merge(tracker_12mo_agency_df,
on='datasetinformation_agency',
how='outer')
# fill missing values
all_agency_df['overdue_datasets'] = all_agency_df['overdue_datasets'].fillna(0)
all_agency_df['numdatasets'] = all_agency_df['numdatasets'].fillna(0)
all_agency_df['numrows'] = all_agency_df['row_count'].fillna(0)
all_agency_df['total_auto_count'] = all_agency_df['total_auto_count'].fillna(0)
all_agency_df['fresh_count'] = all_agency_df['fresh_count'].fillna(0)
all_agency_df['tracker_dataset_count'] = all_agency_df['tracker_dataset_count'].fillna(0)
all_agency_df['tracker_count_ontime'] = all_agency_df['tracker_count_ontime'].fillna(0)
all_agency_df['fresh_pct'] = all_agency_df['fresh_pct'].fillna('No automated datasets')
all_agency_df['pct_ontime'] = all_agency_df['pct_ontime'].fillna('No datasets in the tracker')
# maintain columns names to load data seamlessly to GDS
all_agency_df = all_agency_df[[
'datasetinformation_agency',
'numdatasets',
'numrows',
'fresh_pct',
'pct_ontime',
'overdue_datasets'
]]
all_agency_df.rename(columns={
'datasetinformation_agency':'Agency',
'numdatasets':'Number of datasets',
'numrows':'Number of rows',
'fresh_pct':'Percent of datasets updated on time',
'pct_ontime':'Percent of planned releases released on time within last 12 months',
'overdue_datasets':'Number of overdue for release datasets'
}, inplace=True)
#### Step 3. Build complete dataset-level dataset
# aggregate freshness data and tracker data (for released datasets only)
all_datasets_df = quantity_dataset_df.merge(freshness_dataset_df[['uid',
'update_automation',
'update_updatefrequency',
'fresh']],
on='uid',
how='outer')\
.merge(tracker_12mo_dataset_df[['uid',
'dataset_description',
'latest_plan_date',
'release_status',
'release_date',
'within_grace_period',
'within_grace_period_num']],
on='uid',
how='left')
# append non-released datasets data
# doing it as a separate step to keep more accurate data for released datasets
all_datasets_df = all_datasets_df.append(tracker_12mo_dataset_df[~tracker_12mo_dataset_df['uid'].isin(all_datasets_df['uid'])])\
.reset_index(drop=True)
# merge name and dataset columns since they contain the same information
all_datasets_df.loc[all_datasets_df.name.isna(),'name'] = all_datasets_df['dataset']
# merge automation/update data for "historical" and "as needed" datasets
all_datasets_df = all_datasets_df.merge(public_df[['uid','update_automation','update_updatefrequency']], on='uid', how='left')
all_datasets_df['automation'] = np.where(all_datasets_df['update_automation_x'].isna(),
all_datasets_df['update_automation_y'],
all_datasets_df['update_automation_x'])
all_datasets_df['update_frequency'] = np.where(all_datasets_df['update_updatefrequency_x'].isna(),
all_datasets_df['update_updatefrequency_y'],
all_datasets_df['update_updatefrequency_x'])
# recode missing dates into string NA to properly read format in GDS
all_datasets_df['release_date_fix'] = pd.to_datetime(all_datasets_df['release_date'], errors='coerce')
# update freshness for datastes that are not regularly updated or are not released yet
all_datasets_df.loc[all_datasets_df['update_frequency'].isin(['Historical Data','As needed']),'fresh'] = 'No regular updates'
all_datasets_df.loc[all_datasets_df['release_status']=='Scheduled for release','fresh'] = 'Not yet released'
# freshness for new values of update frequency cannot be determined
# (need to manually add them to update_freq list and assign_dataframe_statuses function)
all_datasets_df['fresh'] = all_datasets_df['fresh'].fillna('Not determined')
all_datasets_df['within_grace_period'] = all_datasets_df['within_grace_period'].fillna('Not in Open Plan Tracker')
all_datasets_df.shape
# maintain columns names to load data seamlessly to GDS
all_datasets_df= all_datasets_df[[
'datasetinformation_agency',
'name',
'url',
'type',
'update_datemadepublic',
'last_data_updated_date',
'automation',
'update_frequency',
'fresh',
'latest_plan_date',
'release_date_fix',
'within_grace_period',
'row_count',
'release_status',
'dataset_description'
]]
all_datasets_df.rename(columns={
'datasetinformation_agency':'Agency',
'name':'Dataset name',
'url':'URL',
'type':'Asset type',
'update_datemadepublic':'Date made public',
'last_data_updated_date':'Last updated on',
'automation':'Automation',
'update_frequency':'Update frequency',
'fresh':'Updated on time',
'latest_plan_date':'Latest Open Data Plan release date',
'release_date_fix':'Open Data Plan release date',
'within_grace_period':'Planned releases released on time within last 12mo?',
'row_count':'Number of rows',
'release_status':'Open Data Plan release status',
'dataset_description':'Description'
},inplace=True)
not_released_datasets_df = all_datasets_df[all_datasets_df['Open Data Plan release status']=='Scheduled for release']
not_released_datasets_df = not_released_datasets_df[['Agency','Dataset name','Description','Latest Open Data Plan release date']]
#### Step 4. Upload data to Google Spreadsheets
# required to avoid exceeding read requests quota
time.sleep(60)
creds.gs_upload(df=citywide_df,
wks_name='_citywide_',
prod=False)
print('Upload complete for citywide dataset')
creds.gs_upload(df=all_agency_df,
wks_name='_agency_',
prod=False)
print('Upload complete for agency dataset')
creds.gs_upload(df=all_datasets_df,
wks_name='_datasets_',
prod=False)
print('Upload complete for datasets dataset')
creds.gs_upload(df=not_released_datasets_df,
wks_name='_datasets_not_released_',
prod=False)
print('Upload complete for not released datasets dataset')
creds.gs_upload(df=dates_df,
wks_name='_dates_',
prod=False)
print('Upload complete for dates dataset')
print(f"Dashboard was updated at: {datetime.now()}")