-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdataverse-file-assessment.py
More file actions
1776 lines (1577 loc) · 80.3 KB
/
Copy pathdataverse-file-assessment.py
File metadata and controls
1776 lines (1577 loc) · 80.3 KB
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
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import csv
import json
import os
import pandas as pd
import re
import requests
import sys
import time
from datetime import datetime, timedelta
from utils import assign_size_bins, extract_max_version, retrieve_all_institutions
###########################################
#### Workflow set-up ####
###########################################
# Read in config file
with open('config.json', 'r') as file:
config = json.load(file)
# toggle for test environment (incomplete run, faster to complete)
test = config['TOGGLES']['test']
# toggle to only look at your/one institution in TDR
only_my_institution = config['TOGGLES']['only_my_institution']
# toggle for stage 3 retrieval
versions_API = config['TOGGLES']['versions_api']
# toggle for retrieving metrics from DataCite
metrics_dc = config['TOGGLES']['metrics_dc']
# toggle for retrieving metrics from Dataverse
metrics_dv = config['TOGGLES']['metrics_dv']
# toggle for excluding unpublished
exclude_drafts = config['TOGGLES']['exclude_drafts']
# toggle for excluding deaccessioned
exclude_deaccessioned = False
## this will change the query filter used in the Search API call for datasets and the filename from outputs
if exclude_drafts:
status = 'publicationStatus:Published'
status_filename = 'PUBLISHED'
else:
status = ''
status_filename = 'ALL'
# toggle to split dataset_entries_native by institution (IN DEVELOPMENT)
split_institution_output = config['TOGGLES']['split_outputs']
# setting timestamp at start of script to calculate run time
start_time = datetime.now()
# creating variable with current date for appending to filenames
today = datetime.now().strftime('%Y%m%d')
# cutoff for checking recency of data dump from TDL
cutoff_months = 6
# filename version of your institution's name
my_institution_filename = config['INSTITUTION']['filename']
## condition what goes in the filename based on toggle for which institution(s) to ping
if only_my_institution:
institution_filename = my_institution_filename
else:
institution_filename = 'all-institutions'
# short-hand version of your institution's name
my_institution_short_name = config['INSTITUTION']['myInstitution']
# root of your institution's dataverse
subtree = config['INSTITUTION']['subtree']
#######################################################################
#### Read in primary funder and affiliation maps ####
#######################################################################
script_dir = os.getcwd()
affiliation_path = f'{script_dir}/affiliation-map-primary.csv'
if os.path.exists(affiliation_path):
ror_map = pd.read_csv(affiliation_path)
print('ROR affiliation map exists and has been loaded.\n')
else:
print('ROR affiliation map does not exist.\n')
funder_path = f'{script_dir}/funder-map-primary.csv'
if os.path.exists(funder_path):
funder_ror_map = pd.read_csv(funder_path)
print('ROR funder map exists and has been loaded..\n')
else:
funder_ror_map = None
print('ROR funder map does not exist.\n')
################################################
#### Import TDL data dump ####
################################################
# Conditionally import TDL data dump
def find_latest_folder(base_path=".", pattern="dataverse-reports-"):
matching_folders = []
for folder in os.listdir(base_path):
folder_path = os.path.join(base_path, folder)
if os.path.isdir(folder_path) and folder.startswith(pattern):
# Assumes this format: dataverse-reports-YYYYMMDD
date_match = re.search(r'(\d{8})$', folder)
if date_match:
date_str = date_match.group(1)
try:
folder_date = datetime.strptime(date_str, "%Y%m%d")
matching_folders.append((folder_path, folder_date, folder))
except ValueError:
continue
if not matching_folders:
return None, None
# Sort by date and return the most recent
latest = sorted(matching_folders, key=lambda x: x[1], reverse=True)[0]
return latest[0], latest[1]
# Identify folder and extract date
dv_report, folder_date = find_latest_folder()
if dv_report is None:
print("No 'dataverse-reports-YYYYMMDD' folder found. Exiting script")
sys.exit()
else:
print(f'Found folder: {os.path.basename(dv_report)}')
print(f'Folder date: {folder_date.strftime('%Y-%m-%d')}')
# Check if folder is recent enough (within 6 months)
cutoff_date = start_time - timedelta(days=(cutoff_months*30))
if folder_date < cutoff_date:
days_old = (start_time - folder_date).days
print(f"\n WARNING: Folder is {days_old} days old (more than {cutoff_months*30} months).")
else:
print(f'Folder is recent (within {cutoff_months*30} months)\n')
try:
combined_datasets_df = pd.read_csv(os.path.join(dv_report, 'datasets-concatenated.csv'))
print('Loaded existing concatenated datasets file.\n')
except FileNotFoundError:
# Get list of Excel files
excel_files = [f for f in os.listdir(dv_report) if f.endswith(".xlsx")]
datasets_list = []
for file in excel_files:
file_path = os.path.join(dv_report, file)
try:
df = pd.read_excel(file_path, sheet_name="datasets")
institution = file.split("-")[0]
df["institution"] = institution
datasets_list.append(df)
print(f'{file} - {len(df)} rows')
except Exception as e:
print(f'Error reading {file}: {e}')
if datasets_list:
combined_datasets_df = pd.concat(datasets_list, ignore_index=True)
output_path = os.path.join(dv_report, "datasets-concatenated.csv")
combined_datasets_df.to_csv(output_path, index=False, encoding="utf-8-sig")
print(f"Saved: {output_path} ({len(combined_datasets_df)} total rows)\n")
# Process dataverses
try:
combined_dataverses_df = pd.read_csv(os.path.join(dv_report, 'dataverses-concatenated.csv'))
print('Loaded existing concatenated dataverses file.\n')
except FileNotFoundError:
print("Processing dataverses...")
dataverses_list = []
for file in excel_files:
file_path = os.path.join(dv_report, file)
try:
df = pd.read_excel(file_path, sheet_name="dataverses")
institution = file.split("-")[0]
df["institution"] = institution
dataverses_list.append(df)
print(f"{file} - {len(df)} rows")
except Exception as e:
print(f"Error reading {file}: {e}")
if dataverses_list:
combined_dataverses_df = pd.concat(dataverses_list, ignore_index=True)
output_path = os.path.join(dv_report, "dataverses-concatenated.csv")
combined_dataverses_df.to_csv(output_path, index=False, encoding="utf-8-sig")
print(f"✓ Saved: {output_path} ({len(combined_dataverses_df)} total rows)")
# Generate pruned versions for merging
cols_datasets_tdl_dump = ['persistentUrl', 'identifier', 'publicationDate', 'versionState', 'createTime', 'contentSize (MB)', 'totalFiles']
combined_datasets_pruned_df = combined_datasets_df[cols_datasets_tdl_dump]
## Label deaccessioned datasets
combined_datasets_pruned_df['versionState'] = combined_datasets_pruned_df['versionState'].fillna('DEACCESSIONED')
cols_dataverses_tdl_dump = ['name', 'alias', 'id', 'dataverseType', 'contactIdentifier', 'contentSize (MB)', 'released', 'institution']
combined_dataverses_pruned_df = combined_dataverses_df[cols_dataverses_tdl_dump]
# Check for directories, create if non-existent
if test:
if os.path.isdir('test'):
print('test directory found - no need to recreate\n')
else:
os.mkdir('test')
print('test directory has been created\n')
test_dir = os.path.join(script_dir, 'test')
os.chdir('test')
if os.path.isdir('outputs'):
print('test outputs directory found - no need to recreate\n')
else:
os.mkdir('outputs')
print('test outputs directory has been created\n')
outputs_dir = os.path.join(test_dir, 'outputs')
if os.path.isdir('logs'):
print('test logs directory found - no need to recreate\n')
else:
os.mkdir('logs')
print('test logs directory has been created\n')
logs_dir = os.path.join(test_dir, 'logs')
else:
if os.path.isdir('outputs'):
print('outputs directory found - no need to recreate\n')
else:
os.mkdir('outputs')
print('outputs directory has been created\n')
outputs_dir = os.path.join(script_dir, 'outputs')
if os.path.isdir('logs'):
print('logs directory found - no need to recreate\n')
else:
os.mkdir('logs')
print('logs directory has been created\n')
logs_dir = os.path.join(script_dir, 'logs')
#############################################
#### Search API set-up ####
#############################################
print('Beginning to define API call parameters.')
url_tdr = 'https://dataverse.tdl.org/api/search/'
# Variable params for test environment
if test and only_my_institution:
page_limit_dataset = config['VARIABLES']['PAGE_LIMITS']['tdr_test']
elif test and not only_my_institution:
page_limit_dataset = config['VARIABLES']['PAGE_LIMITS']['tdr_test'] // 2 #halve page size if retrieving all institutions
elif not test:
page_limit_dataset = config['VARIABLES']['PAGE_LIMITS']['tdr_prod']
page_size_dataset = config['VARIABLES']['PAGE_SIZES']['dataverse_test'] if test else config['VARIABLES']['PAGE_SIZES']['dataverse_prod']
print(f'Retrieving {page_size_dataset} records per page over {page_limit_dataset} pages.')
query = '*'
page_start_dataset = config['VARIABLES']['PAGE_STARTS']['dataverse']
page_increment_dataset = config['VARIABLES']['PAGE_INCREMENTS']['dataverse']
k = 0
headers_tdr = {
'X-Dataverse-key': config['KEYS']['dataverseToken']
}
params_tdr_ut_austin = {
'q': query,
'fq': status,
'subtree': 'utexas',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_baylor = {
'q': query,
'fq': status,
'subtree': 'baylor',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_smu = {
'q': query,
'fq': status,
'subtree': 'smu',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_tamu = {
'q': query,
'fq': status,
'subtree': 'tamu',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_txst = {
'q': query,
'fq': status,
'subtree': 'txst',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_ttu = {
'q': query,
'fq': status,
'subtree': 'ttu',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_houston = {
'q': query,
'fq': status,
'subtree': 'uh',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_hscfw = {
'q': query,
'fq': status,
'subtree': 'unthsc',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_tamug = {
'q': query,
'fq': status,
'subtree': 'tamug',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_tamui = {
'q': query,
'fq': status,
'subtree': 'tamiu',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_utsah = {
'q': query,
'fq': status,
'subtree': 'uthscsa',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_utswm = {
'q': query,
'fq': status,
'subtree': 'utswmed',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_uta = {
'q': query,
'fq': status,
'subtree': 'uta',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_twu = {
'q': query,
'fq': status,
'subtree': 'twu',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
params_tdr_lamar = {
'q': query,
'fq': status,
'subtree': 'lamar',
'type': 'dataset',
'start': page_start_dataset,
'page': page_increment_dataset,
'per_page': page_limit_dataset
}
all_params_datasets = {
'UT Austin': params_tdr_ut_austin,
'Baylor': params_tdr_baylor,
'SMU': params_tdr_smu,
'TAMU': params_tdr_tamu,
'Texas State': params_tdr_txst,
'Texas Tech': params_tdr_ttu,
'Houston': params_tdr_houston,
'HSC Fort Worth': params_tdr_hscfw,
'TAMU Galveston': params_tdr_tamug,
'TAMU International': params_tdr_tamui,
'UT San Antonio Health': params_tdr_utsah,
'UT Southwestern Medical': params_tdr_utswm,
'Lamar': params_tdr_lamar,
'UT Arlington': params_tdr_uta,
"Texas Woman's University": params_tdr_twu
}
# TAMU system-specific
tamu_combined_params = {
'TAMU': params_tdr_tamu,
'TAMU Galveston': params_tdr_tamug,
'TAMU International': params_tdr_tamui
}
if only_my_institution:
if my_institution_short_name == 'TAMU':
params_list = tamu_combined_params
else:
params_list = {
my_institution_short_name: all_params_datasets[my_institution_short_name]
}
else:
params_list = all_params_datasets
print('Starting TDR retrieval.\n')
all_data = retrieve_all_institutions(url_tdr, params_list, headers_tdr, page_start_dataset, page_size_dataset, page_limit_dataset)
print('Starting TDR filtering.\n')
dataset_entries = []
for item in all_data:
id = item.get('global_id', '')
type = item.get('type', '')
institution = item.get('institution','')
status = item.get('versionState', '')
first_created = item.get('createdAt', '')
description = item.get('description', '')
keywords = item.get('keywords', '')
subjects = item.get('subjects', '')
name = item.get('name', '')
dataverse = item.get('name_of_dataverse', '')
dataverse_code = item.get('identifier_of_dataverse', '')
majorV = item.get('majorVersion', 0)
minorV = item.get('minorVersion', 0)
comboV = f'{majorV}.{minorV}'
version_id = item.get('versionId', '')
dataset_entries.append({
'institution': institution,
'doi': id,
# 'type': type,
# 'description': description,
'subjects': subjects,
# 'keywords': keywords,
# 'status': status,
'created_original': first_created,
'dataset_title': name,
'dataverse': dataverse,
'alias': dataverse_code,
# 'major_version': majorV,
# 'minor_version': minorV,
'total_version': comboV,
'version_id': version_id
})
df_dataset_entries = pd.DataFrame(dataset_entries)
#####################################################
#### Process Search API dataset_entries_native ####
#####################################################
# Ensuring full version (float not integer)
df_dataset_entries['total_version'] = df_dataset_entries['total_version'].apply(extract_max_version)
# Add Boolean for versioned
df_dataset_entries['versioned'] = df_dataset_entries.apply(lambda row: 'Versioned' if (row['total_version'] > 1.0) else 'Not versioned', axis=1)
# Clean up DOI field
df_dataset_entries['doi'] = df_dataset_entries['doi'].str.replace('doi:', '')
# Create PURL link to align with data dump files
df_dataset_entries['persistentUrl'] = 'https://doi.org/' + df_dataset_entries['doi']
# Combine with dataset-level data dump df if it exists
## Right now, the script will not reach this point if the data dump doesn't exist anyway
if combined_datasets_pruned_df is not None:
df_dataset_entries = pd.merge(combined_datasets_pruned_df, df_dataset_entries, on='persistentUrl', how='left')
#sort on status, setting 'DRAFT' at bottom to remove this version for published datasets that are in draft state, retain entry of 'PUBLISHED'
# df_dataset_entries = df_dataset_entries.sort_values(by='status', ascending=False)
df_dataset_entries.to_csv(f'outputs/{today}_{institution_filename}_all-deposits.csv')
# filtered_tdr_deduplicated = df_dataset_entries.drop_duplicates(subset=['identifier'], keep='first')
# filtered_tdr_deduplicated.to_csv(f'outputs/{today}_{institution_filename}_all-deposits-deduplicated.csv', index=False, encoding='utf-8-sig')
# #create df of published datasets with draft version (retains both entries)
# commonColumns = ['identifier', 'dataset_title']
# duplicates = df_dataset_entries.duplicated(subset=commonColumns, keep=False)
# dual_status_datasets = df_dataset_entries[duplicates]
# dual_status_datasets.to_csv(f'outputs/{today}_{institution_filename}_dual-status-datasets.csv', index=False, encoding='utf-8-sig')
#############################################
#### Native API set-up ####
#############################################
print('Starting Native API call')
url_tdr_native = 'https://dataverse.tdl.org/api/datasets/'
# Only retrieve DOIs that exist and can be retrieved by a liaison
## A superuser could get information on unpublished datasets, but a liaison can only get this for their institution
df_datasets_published = df_dataset_entries.dropna(subset=['doi'])
print(f'Total datasets to be analyzed: {len(df_datasets_published)}.\n')
dataset_entries_native = []
first_timeouts = []
second_timeouts = []
final_timeouts = []
for doi in df_datasets_published['doi']:
try:
response = requests.get(f'{url_tdr_native}:persistentId/?persistentId=doi:{doi}', headers=headers_tdr, timeout=5)
if response.status_code == 200:
print(f'Retrieving metadata for: {doi}\n')
dataset_entries_native.append(response.json())
time.sleep(0.2)
else:
final_timeouts.append({"doi": doi, "reason": f"Status {response.status_code}"})
except requests.exceptions.Timeout:
first_timeouts.append(doi)
except requests.exceptions.RequestException as e:
final_timeouts.append({"doi": doi, "reason": str(e)})
if first_timeouts:
print(f"\n--- Retrying {len(first_timeouts)} timeouts with 5s limit ---\n")
time.sleep(2)
for doi in first_timeouts:
try:
response = requests.get(f'{url_tdr_native}:persistentId/?persistentId=doi:{doi}', headers=headers_tdr, timeout=5)
if response.status_code == 200:
print(f'Retrying call for: {doi}\n')
dataset_entries_native.append(response.json())
time.sleep(0.2)
else:
final_timeouts.append({"doi": doi, "reason": f"Status {response.status_code}"})
except requests.exceptions.Timeout:
second_timeouts.append(doi)
except requests.exceptions.RequestException as e:
final_timeouts.append({"doi": doi, "reason": str(e)})
if second_timeouts:
print(f"\n--- Retrying {len(second_timeouts)} repeat timeouts with 10s limit ---\n")
time.sleep(2)
for doi in second_timeouts:
try:
response = requests.get(f'{url_tdr_native}:persistentId/?persistentId=doi:{doi}', headers=headers_tdr, timeout=10)
if response.status_code == 200:
print(f'Retrying call for {doi} again\n')
dataset_entries_native.append(response.json())
time.sleep(0.2)
else:
final_timeouts.append({"doi": doi, "reason": f"Retry Status {response.status_code}"})
except Exception as e:
final_timeouts.append({"doi": doi, "reason": f"Persistent Timeout/Error: {e}"})
print('Done retrieving dataset_entries_native\n')
data_tdr_native = {
'datasets': dataset_entries_native
}
print(f"INITIALLY FAILED: {len(first_timeouts)}\n")
print(f"TOTAL FAILED: {len(final_timeouts)}\n")
if len(final_timeouts) > 0:
print(final_timeouts)
# Saving failed retrievals
with open(f'{logs_dir}/{today}_failed-retrievals.csv', 'w', newline='', encoding='utf-8') as f:
fieldnames = ['Date', 'DOI', 'Error Message']
writer = csv.DictWriter(f, fieldnames=fieldnames)
writer.writeheader()
for item in final_timeouts:
writer.writerow({
'Date': today,
'DOI': item['doi'],
'Error Message': item['reason']
})
print('Beginning dataframe subsetting\n')
file_entries = []
author_entries = []
for item in data_tdr_native['datasets']:
data = item.get('data', '')
dataset_id = data.get('id', '')
pubDate = data.get('publicationDate', '')
latest = data.get('latestVersion', {})
status = latest.get('versionState', '')
status2 = latest.get('latestVersionPublishingState', '')
doi = latest.get('datasetPersistentId', '')
updateDate = latest.get('lastUpdateTime', '')
createDate = latest.get('createTime', '')
releaseDate = latest.get('releaseTime', '')
license = latest.get('license', {})
licenseName = license.get('name', None)
terms = latest.get('termsOfUse', None)
usage = licenseName if licenseName is not None else terms
confidentiality = latest.get('confidentialityDeclaration', None)
permission = latest.get('specialPermissions', None)
restrictions = latest.get('restrictions', None)
requirements = latest.get('depositorRequirements', None)
conditions = latest.get('conditions', None)
disclaimer = latest.get('disclaimer', None)
terms_access = latest.get('termsOfAccess', None)
data_access_place = latest.get('dataAccessPlace', None)
availability = latest.get('availabilityStatus', None)
contact_access = latest.get('contactForAccess', None)
files = latest.get('files', [])
citation = latest.get('metadataBlocks', {}).get('citation', {})
fields = citation.get('fields', [])
grant_agencies = 'No funding listed'
keywords = None
notes = None
depositor = 'None listed'
contacts = 'None listed'
contact_emails = 'None listed'
for field in fields:
if field['typeName'] == 'grantNumber':
grant_agencies = []
for grant in field.get('value', []):
grant_number_agency = grant.get('grantNumberAgency', {}).get('value', '')
grant_agencies.append(grant_number_agency)
grant_agencies = '; '.join(grant_agencies)
if field['typeName'] == 'subject':
subjects = field.get('value', [])
if field['typeName'] == 'notesText':
notes = field.get('value', '')
if field['typeName'] == 'keyword':
keywords = []
for keyword_dict in field.get('value', []):
keyword_value = keyword_dict.get('keywordValue', {}).get('value', '')
if keyword_value:
keywords.append(keyword_value)
keywords_str = '; '.join(keywords)
if field['typeName'] == 'datasetContact':
contacts = []
contact_emails = []
for contact in field.get('value', []):
contact_value = contact.get('datasetContactName', {}).get('value', '')
contact_email_value = contact.get('datasetContactEmail', {}).get('value', '')
if contact_value:
contacts.append(contact_value)
if contact_email_value:
contact_emails.append(contact_email_value)
contacts = '; '.join(contacts)
contact_emails = '; '.join(contact_emails)
if field['typeName'] == 'depositor':
depositor = field.get('value', '')
num_authors = 0
for field in fields:
if field['typeName'] == 'author':
for position, author in enumerate(field.get('value', []), start=1):
num_authors += 1
total_filesize = 0
unique_content_types = set()
fileCount = len(files)
base_entry = {
'dataset_id': dataset_id,
'doi': doi,
# 'notes': notes,
'funders': grant_agencies,
'dataset_contact': contacts,
'dataset_email': contact_emails,
'dataset_depositor': depositor,
# 'current_status': status2,
# 'reuse_requirements': usage,
'license': licenseName,
# 'confidentiality': confidentiality,
# 'permission': permission,
# 'restrictions': restrictions,
# 'requirements': requirements,
# 'conditions': conditions,
# 'disclaimer': disclaimer,
# 'terms_access': terms_access,
# 'data_access_place': data_access_place,
# 'availability': availability,
# 'contact_access': contact_access
}
if files:
for file in files:
file_info = file.get('dataFile', {})
file_entry = base_entry.copy()
file_entry.update({
'file_id': file_info.get('id', ''),
'filename': file_info.get('filename', ''),
# 'mime_type': file_info.get('contentType', ''),
# 'friendly_type': file_info.get('friendlyType', ''),
'original_mime_type': file_info.get('originalFileFormat', file_info.get('contentType', '')),
# 'original_friendly_type': file_info.get('originalFormatLabel', file_info.get('friendlyType', '')),
# 'tabular': file_info.get('tabularData', ''),
'file_size': file_info.get('filesize', 0),
# 'original_file_size': file_info.get('originalFileSize', 0),
'storage_identifier': file_info.get('storageIdentifier', ''),
'file_creation_date': file_info.get('creationDate', ''),
'file_publication_date': file_info.get('publicationDate', ''),
'restricted': file.get('restricted', ''),
})
file_entries.append(file_entry)
else:
file_entry = base_entry.copy()
file_entry.update({
'file_id': 'NO FILES',
'filename': 'NO FILES',
# 'mime_type': 'NO FILES',
# 'friendly_type': 'NO FILES',
'original_mime_type': 'NO FILES',
# 'original_friendly_type': 'NO FILES',
# 'tabular': 'NO FILES',
'file_size': 0,
# 'original_file_size': 'NO FILES',
'storage_identifier': 'NO FILES',
'file_creation_date': None,
'file_publication_date': None,
'restricted': 'NO FILES',
})
file_entries.append(file_entry)
# df with entries for individual authors
for item in data_tdr_native['datasets']:
data = item.get('data', {})
latest = data.get('latestVersion', {})
doi = latest.get('datasetPersistentId', '')
citation = latest.get('metadataBlocks', {}).get('citation', {})
status2 = latest.get('latestVersionPublishingState', '')
fields = citation.get('fields', [])
for field in fields:
if field['typeName'] == 'author':
num_authors = len(field.get('value', []))
for position, author in enumerate(field.get('value', []), start=1):
name = author.get('authorName', {}).get('value', '')
affiliation = author.get('authorAffiliation', {}).get('value', '')
identifier = author.get('authorIdentifier', {}).get('value', '')
scheme = author.get('authorIdentifierScheme', {}).get('value', '')
affiliation_expanded = author.get('authorAffiliation', {}).get('expandedvalue', {}).get('termName', '')
identifier_expanded = author.get('authorIdentifier', {}).get('expandedvalue', {}).get('@id', '')
affiliationName = affiliation_expanded if affiliation_expanded else affiliation
affiliation_ror = affiliation if affiliation_expanded else None
author_entry = {
'doi': doi,
'current_status': status2,
'author_name': name,
'author_affiliation': affiliationName,
'ror_id': affiliation_ror,
'author_identifier': identifier,
'author_identifier_expanded': identifier_expanded,
'author_identifier_scheme': scheme,
'author_count': num_authors,
'author_position': position
}
author_entries.append(author_entry)
df_file_entries = pd.json_normalize(file_entries)
df_author_entries = pd.json_normalize(author_entries)
#####################################################
#### Process Native API dataset_entries_native ####
#####################################################
# Clean up DOI field
df_file_entries['doi'] = df_file_entries['doi'].str.replace('doi:', '')
df_author_entries['doi'] = df_author_entries['doi'].str.replace('doi:', '')
# Reformatting dates
df_file_entries['file_creation_date'] = pd.to_datetime(df_file_entries['file_creation_date'])
df_file_entries['file_creation_year'] = pd.to_datetime(df_file_entries['file_creation_date'], format='%Y-%m-%dT%H:%M:%SZ').dt.year
df_file_entries['file_publication_year'] = pd.to_datetime(df_file_entries['file_publication_date'], format='%Y-%m-%d').dt.year
df_file_entries['category_mime_type'] = df_file_entries['original_mime_type'].str.extract(r'(\w+)/')
df_file_entries = assign_size_bins(df_file_entries, column='file_size', new_column='file_size_bin')
df_files_datasets = pd.merge(df_dataset_entries, df_file_entries, on='doi', how='right')
# Group columns for pruning dfs
core_dataset_cols = ['institution', 'dataverse', 'alias', 'dataset_title', 'doi', 'dataset_id', 'dataset_contact','dataset_email','dataset_depositor','license', 'subjects', 'funders', 'total_version']
core_file_cols = ['filename', 'file_id', 'original_mime_type', 'file_size', 'storage_identifier', 'file_creation_date', 'file_publication_date', 'created_original', 'file_size_bin', 'restricted']
accessory_dataset_cols = ['notes', 'keywords', 'current_status']
accessory_file_cols = ['reuse_requirements', 'confidentiality', 'permission', 'restrictions', 'conditions', 'disclaimer', 'terms_access', 'data_access_place', 'availability', 'contact_access']
#####################################################
#### Preparing for Versions API ####
#####################################################
if versions_API:
# Subset to datasets that are less than version 2.0 (no major update = no file additions)
## Note that superusers can overwrite an existing version, so this is not foolproof
df_files_datasets_majorVersion = df_files_datasets[df_files_datasets['major_version'] > 1]
# Remove datasets that have never been published (will not return any info for this endpoint)
df_files_datasets_published = df_files_datasets_majorVersion[df_files_datasets_majorVersion['publication_date'].notnull()]
# Deduplicate on dataset_id
df_files_datasets_published_dedup = df_files_datasets_published.drop_duplicates(subset='dataset_id', keep='first')
dataset_results_versions = []
print('Beginning Version API query\n')
for dataset_id in df_files_datasets_published_dedup['dataset_id']:
try:
response = requests.get(f'{url_tdr_native}{dataset_id}/versions')
if response.status_code == 200:
print(f'Retrieving versions of dataset #{dataset_id}')
print()
dataset_results_versions.append(response.json())
time.sleep(0.2)
else:
print(f'Error retrieving dataset #{dataset_id}: {response.status_code}, {response.text}')
except requests.exceptions.RequestException as e:
print(f'Timeout error on DOI {doi}: {e}')
data_tdr_versions = {
'datasets': dataset_results_versions
}
print('Beginning dataframe subsetting\n')
dataset_entries_versions = []
for dataset in data_tdr_versions['datasets']:
data = dataset.get('data', [])
for item in data:
doi = item.get('datasetPersistentId', '')
id = item.get('id', '')
datasetid = item.get('datasetId', '')
majorV = str(item.get('versionNumber', 0))
minorV = str(item.get('versionMinorNumber', 0))
status2 = latest.get('latestVersionPublishingState', '')
comboV = f'{majorV}.{minorV}'
status = item.get('versionState', '')
license = item.get('license', {})
licenseName = license.get('name', None)
terms = item.get('termsOfUse', None)
confidentiality = item.get('confidentialityDeclaration', None)
permission = item.get('specialPermissions', None)
restrictions = item.get('restrictions', None)
requirements = item.get('depositorRequirements', None)
conditions = item.get('conditions', None)
disclaimer = item.get('disclaimer', None)
terms_access = item.get('termsOfAccess', None)
data_access_place = item.get('dataAccessPlace', None)
availability = item.get('availabilityStatus', None)
contact_access = item.get('contactForAccess', None)
usage = licenseName if licenseName is not None else terms
citation = latest.get('metadataBlocks', {}).get('citation', {})
files = item.get('files', [])
keywords = None
notes = None
fields = citation.get('fields', [])
for field in fields:
if field['typeName'] == 'subject':
subjects = field.get('value', [])
if field['typeName'] == 'notesText':
notes = field.get('value', [])
if field['typeName'] == 'keyword':
keywords = []
for keyword_dict in field.get('value', []):
keyword_value = keyword_dict.get('keywordValue', {}).get('value', '')
if keyword_value:
keywords.append(keyword_value)
keywords_str = ';'.join(keywords)
if field['typeName'] == 'datasetContact':
contacts = []
for contact in field.get('value', []):
contact_value = contact.get('datasetContactName', {}).get('value', '')
if contact_value:
contacts.append(contact_value)
contacts = ';'.join(contacts)
if files:
for file in files:
file_info = file['dataFile']
unique_content_types.add(file_info['contentType'])
file_entry = {
'dataset_id': dataset_id,
'doi': doi,
'notes': notes,
'dataset_contact': contacts,
'dataset_email': contact_emails,
'dataset_depositor': depositor,
#'status': status,
'current_status': status2,
'reuse_requirements': usage,
# 'keywords': keywords,
#'fileCount': fileCount,
#'unique_content_types': list(unique_content_types),
'file_id': file_info.get('id', ''),
'public': file_info.get('restricted', ''),
'filename': file_info.get('filename', ''),
'mime_type': file_info.get('contentType', ''),
'friendly_type': file_info.get('friendlyType', ''),
'original_mime_type': file_info.get('originalFileFormat', file_info.get('contentType', '')), #falls back to contentType if already original
'original_friendly_type': file_info.get('originalFormatLabel', file_info.get('friendlyType', '')), #falls back to friendlyType if already original
'tabular': file_info.get('tabularData', ''),
'file_size': file_info.get('filesize', 0),
'original_file_size': file_info.get('originalFileSize', 0),
'storage_identifier': file_info.get('storageIdentifier', ''),
'creation_date': file_info.get('creationDate', ''),
'publication_date': file_info.get('publicationDate', ''),
# 'publication_day': get_day_of_week(pubDate),
# 'is_holiday': is_us_federal_holiday(pubDate),
'restricted': file.get('restricted', ''),
'license': licenseName,
'confidentiality': confidentiality,
'permission': permission,
'restrictions': restrictions,
'requirements': requirements,
'conditions': conditions,
'disclaimer': disclaimer,
'terms_access': terms_access,
'data_access_place': data_access_place,
'availability': availability,
'contact_access': contact_access
}
dataset_entries_versions.append(file_entry)
else:
file_entry = {
'dataset_id': dataset_id,
'doi': doi,
'dataset_contact': contacts,
'dataset_email': contact_emails,
'dataset_depositor': depositor,
'current_status': status2,
'reuse_requirements': usage,
'file_id': 'NO FILES',
'public': 'NO FILES',
'filename': 'NO FILES',
'mime_type': 'NO FILES',
'friendly_type': 'NO FILES',
'original_mime_type': 'NO FILES',
'original_friendly_type': 'NO FILES',
'tabular': 'NO FILES',
'file_size': 'NO FILES',
'original_file_size': 'NO FILES',
'storage_identifier': 'NO FILES',
'creation_date': None,
'publication_date': None,
'restricted': 'NO FILES',
'license': licenseName,
'confidentiality': confidentiality,
'permission': permission,
'restrictions': restrictions,
'requirements': requirements,
'conditions': conditions,
'disclaimer': disclaimer,
'terms_access': terms_access,
'data_access_place': data_access_place,
'availability': availability,
'contact_access': contact_access
}
dataset_entries_versions.append(file_entry)
#getting dataframe with entries for individual authors
author_entries_versions = []
for dataset in data_tdr_versions['datasets']:
data = dataset.get('data', [])
for item in data:
doi = item.get('datasetPersistentId', '')
id = item.get('id', '')
status2 = item.get('latestVersionPublishingState', '')
datasetid = item.get('datasetId', '')
citation = item.get('metadataBlocks', {}).get('citation', {})
fields = citation.get('fields', [])
for field in fields:
if field['typeName'] == 'author':
for author in field.get('value', []):
name = author.get('authorName', {}).get('value', '')
affiliation = author.get('authorAffiliation', {}).get('value', '')
identifier = author.get('authorIdentifier', {}).get('value', '')
scheme = author.get('authorIdentifierScheme', {}).get('value', '')
affiliation_expanded = author.get('authorAffiliation', {}).get('expandedvalue', {}).get('termName', '')
identifier_expanded = author.get('authorIdentifier', {}).get('expandedvalue', {}).get('@id', '')
affiliationName = affiliation_expanded if affiliation_expanded else affiliation
affiliation_ror = affiliation if affiliation_expanded else None
author_entry = {
'doi': doi,
'current_status': status2,
'author_name': name,
'author_affiliation': affiliationName,
'ror_id': affiliation_ror,
'author_identifier': identifier,
'author_identifier_expanded': identifier_expanded,
'author_identifier_scheme': scheme
}
author_entries_versions.append(author_entry)
df_file_entries_versions = pd.json_normalize(dataset_entries_versions)
df_author_entries_versions = pd.json_normalize(author_entries_versions)
#######################################################
#### Process Versions API dataset_entries_native ####
#######################################################