Skip to content

Commit fe7f8ac

Browse files
committed
new grammar
1 parent 9280a27 commit fe7f8ac

File tree

1 file changed

+54
-43
lines changed

1 file changed

+54
-43
lines changed

dimcli/core/dsl_grammar_core.py

Lines changed: 54 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -420,6 +420,15 @@
420420
"long_description": None,
421421
"type": "string",
422422
},
423+
"overall_status": {
424+
"description": "Status of the trial as provided by the registry.",
425+
"is_entity": False,
426+
"is_facet": True,
427+
"is_filter": True,
428+
"is_multivalue": False,
429+
"long_description": None,
430+
"type": "string",
431+
},
423432
"phase": {
424433
"description": "Phase of the clinical trial, as a string.",
425434
"is_entity": False,
@@ -577,11 +586,11 @@
577586
"fieldsets": ["basics", "extras", "categories", "studies"],
578587
"metrics": {"count": {"description": "Total count", "name": "count"}},
579588
"search_fields": [
580-
"full_data",
581589
"title_only",
582-
"investigators",
583590
"title_abstract_only",
584591
"raw_affiliations",
592+
"investigators",
593+
"full_data",
585594
],
586595
},
587596
"datasets": {
@@ -958,7 +967,7 @@
958967
},
959968
"fieldsets": ["basics", "categories"],
960969
"metrics": {"count": {"description": "Total count", "name": "count"}},
961-
"search_fields": ["title_abstract_only", "title_only", "full_data"],
970+
"search_fields": ["title_only", "title_abstract_only", "full_data"],
962971
},
963972
"funder_groups": {
964973
"fields": {
@@ -1348,7 +1357,7 @@
13481357
"type": "json",
13491358
},
13501359
"keywords": {
1351-
"description": "Keywords provided by the original data source.",
1360+
"description": "Keywords provided by the original data cfg_models.Source.",
13521361
"is_entity": False,
13531362
"is_facet": True,
13541363
"is_filter": True,
@@ -1393,7 +1402,7 @@
13931402
"type": "string",
13941403
},
13951404
"project_numbers": {
1396-
"description": "Grant identifiers, as provided by the source (e.g., funder, aggregator) the grant was derived from.",
1405+
"description": "Grant identifiers, as provided by the cfg_models.Source (e.g., funder, aggregator) the grant was derived from.",
13971406
"is_entity": False,
13981407
"is_facet": False,
13991408
"is_filter": True,
@@ -1447,7 +1456,7 @@
14471456
"type": "string",
14481457
},
14491458
"research_orgs": {
1450-
"description": "GRID organisations receiving the grant (note: identifiers are automatically extracted from the source text and can be missing in some cases).",
1459+
"description": "GRID organisations receiving the grant (note: identifiers are automatically extracted from the cfg_models.Source text and can be missing in some cases).",
14511460
"is_entity": True,
14521461
"is_facet": True,
14531462
"is_filter": True,
@@ -1510,18 +1519,18 @@
15101519
},
15111520
},
15121521
"search_fields": [
1513-
"concepts",
1514-
"full_data",
15151522
"title_only",
1516-
"investigators",
15171523
"title_abstract_only",
1524+
"concepts",
15181525
"raw_affiliations",
1526+
"investigators",
1527+
"full_data",
15191528
],
15201529
},
15211530
"organizations": {
15221531
"fields": {
15231532
"acronym": {
1524-
"description": 'GRID acronym of the organization. E.g., "UT" for `grid.26999.3d <https://app.dimensions.ai/details/organization/grid.26999.3d>`_',
1533+
"description": 'Acronym of the organization. E.g., "UT" for `grid.26999.3d <https://app.dimensions.ai/details/organization/grid.26999.3d>`_',
15251534
"is_entity": False,
15261535
"is_facet": False,
15271536
"is_filter": True,
@@ -1530,7 +1539,7 @@
15301539
"type": "string",
15311540
},
15321541
"city_name": {
1533-
"description": 'GRID name of the organization country. E.g., "Bethesda" for `grid.419635.c <https://app.dimensions.ai/details/organization/grid.419635.c>`_',
1542+
"description": 'Name of the organization city. E.g., "Bethesda" for `grid.419635.c <https://app.dimensions.ai/details/organization/grid.419635.c>`_',
15341543
"is_entity": False,
15351544
"is_facet": True,
15361545
"is_filter": True,
@@ -1557,7 +1566,7 @@
15571566
"type": "string",
15581567
},
15591568
"country_name": {
1560-
"description": 'GRID name of the organization country. E.g., "Japan" for `grid.26999.3d <https://app.dimensions.ai/details/organization/grid.26999.3d>`_',
1569+
"description": 'Name of the organization country. E.g., "Japan" for `grid.26999.3d <https://app.dimensions.ai/details/organization/grid.26999.3d>`_',
15611570
"is_entity": False,
15621571
"is_facet": True,
15631572
"is_filter": True,
@@ -1602,7 +1611,7 @@
16021611
"type": "string",
16031612
},
16041613
"id": {
1605-
"description": 'GRID ID of the organization. E.g., "grid.26999.3d".',
1614+
"description": 'ID of the organization. E.g., "grid.26999.3d".',
16061615
"is_entity": False,
16071616
"is_facet": False,
16081617
"is_filter": True,
@@ -1647,7 +1656,7 @@
16471656
"type": "float",
16481657
},
16491658
"name": {
1650-
"description": 'GRID name of the organization. E.g., "University of Tokyo" for `grid.26999.3d <https://app.dimensions.ai/details/organization/grid.26999.3d>`_',
1659+
"description": 'Name of the organization. E.g., "University of Tokyo" for `grid.26999.3d <https://app.dimensions.ai/details/organization/grid.26999.3d>`_',
16511660
"is_entity": False,
16521661
"is_facet": False,
16531662
"is_filter": True,
@@ -1746,7 +1755,7 @@
17461755
"type": "string",
17471756
},
17481757
"redirect": {
1749-
"description": "GRID ID of an organization this one was redirected to",
1758+
"description": "ID of an organization this one was redirected to",
17501759
"is_entity": False,
17511760
"is_facet": False,
17521761
"is_filter": True,
@@ -1773,7 +1782,7 @@
17731782
"type": "float",
17741783
},
17751784
"state_name": {
1776-
"description": 'GRID name of the organization country. E.g., "Maryland" for `grid.419635.c <https://app.dimensions.ai/details/organization/grid.419635.c>`_',
1785+
"description": 'Name of the organization state. E.g., "Maryland" for `grid.419635.c <https://app.dimensions.ai/details/organization/grid.419635.c>`_',
17771786
"is_entity": False,
17781787
"is_facet": True,
17791788
"is_filter": True,
@@ -1782,7 +1791,7 @@
17821791
"type": "string",
17831792
},
17841793
"status": {
1785-
"description": "Status of an organization. May be be one of:\n \n * `a`: active organization\n * `o`: obsolete organization\n * `r`: redirected organization, see field `redirect` to obtain the GRID ID of an organization this one was redirected to",
1794+
"description": "Status of an organization. May be be one of:\n \n * `a`: active organization\n * `o`: obsolete organization\n * `r`: redirected organization, see field `redirect` to obtain the ID of an organization this one was redirected to",
17861795
"is_entity": False,
17871796
"is_facet": True,
17881797
"is_filter": True,
@@ -2359,10 +2368,11 @@
23592368
"fieldsets": ["basics", "extras", "categories"],
23602369
"metrics": {"count": {"description": "Total count", "name": "count"}},
23612370
"search_fields": [
2362-
"inventors",
23632371
"title_only",
2364-
"assignees",
23652372
"title_abstract_only",
2373+
"assignees",
2374+
"inventors",
2375+
"title_abstract_claims",
23662376
"full_data",
23672377
],
23682378
},
@@ -2583,7 +2593,7 @@
25832593
"type": "string",
25842594
},
25852595
"acknowledgements": {
2586-
"description": "The acknowledgements section text as found in the source document.",
2596+
"description": "The acknowledgements section text as found in the cfg_models.Source document.",
25872597
"is_entity": False,
25882598
"is_facet": False,
25892599
"is_filter": False,
@@ -2889,7 +2899,7 @@
28892899
"type": "organizations",
28902900
},
28912901
"funding_section": {
2892-
"description": "The funding section text as found in the source document",
2902+
"description": "The funding section text as found in the cfg_models.Source document",
28932903
"is_entity": False,
28942904
"is_facet": False,
28952905
"is_filter": True,
@@ -2952,7 +2962,7 @@
29522962
"type": "string",
29532963
},
29542964
"journal_title_raw": {
2955-
"description": "The journal title, as it appears in the original source (note: this field can be used to retrieve historical titles of journals whose official title was later updated).",
2965+
"description": "The journal title, as it appears in the original cfg_models.Source (note: this field can be used to retrieve historical titles of journals whose official title was later updated).",
29562966
"is_entity": False,
29572967
"is_facet": False,
29582968
"is_filter": True,
@@ -3168,7 +3178,7 @@
31683178
"type": "float",
31693179
},
31703180
"source_title": {
3171-
"description": "Source Title for the Publication.",
3181+
"description": "cfg_models.Source Title for the Publication.",
31723182
"is_entity": True,
31733183
"is_facet": True,
31743184
"is_filter": True,
@@ -3277,14 +3287,15 @@
32773287
},
32783288
},
32793289
"search_fields": [
3280-
"acknowledgements",
3281-
"concepts",
32823290
"full_data_exact",
3291+
"title_only",
32833292
"terms",
3293+
"authors",
3294+
"funding",
3295+
"acknowledgements",
32843296
"title_abstract_only",
3297+
"concepts",
32853298
"raw_affiliations",
3286-
"authors",
3287-
"title_only",
32883299
"full_data",
32893300
],
32903301
},
@@ -3300,7 +3311,7 @@
33003311
"type": "string",
33013312
},
33023313
"authors": {
3303-
"description": "Ordered list of authors names and their affiliations, as they appear in the source. The list can include researcher and organization identifiers, when available.",
3314+
"description": "Ordered list of authors names and their affiliations, as they appear in the cfg_models.Source. The list can include researcher and organization identifiers, when available.",
33043315
"is_entity": False,
33053316
"is_facet": False,
33063317
"is_filter": True,
@@ -3462,7 +3473,7 @@
34623473
"type": "json",
34633474
},
34643475
"funder_details": {
3465-
"description": "Sponsors/funders of the research/report, as they appear in the source.",
3476+
"description": "Sponsors/funders of the research/report, as they appear in the cfg_models.Source.",
34663477
"is_entity": False,
34673478
"is_facet": False,
34683479
"is_filter": True,
@@ -3498,7 +3509,7 @@
34983509
"type": "string",
34993510
},
35003511
"keywords": {
3501-
"description": "Keywords, as provided by the source.",
3512+
"description": "Keywords, as provided by the cfg_models.Source.",
35023513
"is_entity": False,
35033514
"is_facet": False,
35043515
"is_filter": True,
@@ -3516,7 +3527,7 @@
35163527
"type": "string",
35173528
},
35183529
"publisher_details": {
3519-
"description": "Organizations publishing the report, as they appear in the source.",
3530+
"description": "Organizations publishing the report, as they appear in the cfg_models.Source.",
35203531
"is_entity": False,
35213532
"is_facet": False,
35223533
"is_filter": True,
@@ -3570,7 +3581,7 @@
35703581
"type": "states",
35713582
},
35723583
"research_orgs": {
3573-
"description": "Combined list of GRID organisations associated with the report, because the source marks them as responsible for it, or because they appear as authors affiliations.",
3584+
"description": "Combined list of GRID organisations associated with the report, because the cfg_models.Source marks them as responsible for it, or because they appear as authors affiliations.",
35743585
"is_entity": True,
35753586
"is_facet": True,
35763587
"is_filter": True,
@@ -3606,7 +3617,7 @@
36063617
"type": "countries",
36073618
},
36083619
"responsible_orgs_details": {
3609-
"description": "Organizations responsible for the report, as they appear in the source. Note: this can be different from the author affiliations.",
3620+
"description": "Organizations responsible for the report, as they appear in the cfg_models.Source. Note: this can be different from the author affiliations.",
36103621
"is_entity": False,
36113622
"is_facet": False,
36123623
"is_filter": True,
@@ -3653,7 +3664,7 @@
36533664
},
36543665
"fieldsets": ["basics", "categories"],
36553666
"metrics": {"count": {"description": "Total count", "name": "count"}},
3656-
"search_fields": ["concepts", "title_abstract_only", "full_data"],
3667+
"search_fields": ["title_abstract_only", "concepts", "full_data"],
36573668
},
36583669
"research_org_groups": {
36593670
"fields": {
@@ -3852,7 +3863,7 @@
38523863
"source_titles": {
38533864
"fields": {
38543865
"id": {
3855-
"description": "The Dimensions ID of the source.",
3866+
"description": "The Dimensions ID of the source title.",
38563867
"is_entity": False,
38573868
"is_facet": False,
38583869
"is_filter": True,
@@ -3861,7 +3872,7 @@
38613872
"type": "string",
38623873
},
38633874
"issn": {
3864-
"description": "List of known ISSNs for the source, including both print and electronic.",
3875+
"description": "List of known ISSNs for the source title, including both print and electronic.",
38653876
"is_entity": False,
38663877
"is_facet": False,
38673878
"is_filter": True,
@@ -3870,7 +3881,7 @@
38703881
"type": "string",
38713882
},
38723883
"issn_electronic": {
3873-
"description": "Electronic ISSN for the source.",
3884+
"description": "Electronic ISSN for the source title.",
38743885
"is_entity": False,
38753886
"is_facet": False,
38763887
"is_filter": True,
@@ -3879,7 +3890,7 @@
38793890
"type": "string",
38803891
},
38813892
"issn_print": {
3882-
"description": "Print ISSN for the source.",
3893+
"description": "Print ISSN for the source title.",
38833894
"is_entity": False,
38843895
"is_facet": False,
38853896
"is_filter": True,
@@ -3897,7 +3908,7 @@
38973908
"type": "string",
38983909
},
38993910
"linkout": {
3900-
"description": "The source web URL, if known.",
3911+
"description": "The source title web URL, if known.",
39013912
"is_entity": False,
39023913
"is_facet": False,
39033914
"is_filter": False,
@@ -3924,7 +3935,7 @@
39243935
"type": "float",
39253936
},
39263937
"snip": {
3927-
"description": "SNIP indicator (source normalized impact per paper). This indicator measures the average citation impact of the publications of a journal.",
3938+
"description": "SNIP indicator (source title normalized impact per paper). This indicator measures the average citation impact of the publications of a journal.",
39283939
"is_entity": False,
39293940
"is_facet": False,
39303941
"is_filter": True,
@@ -3933,7 +3944,7 @@
39333944
"type": "float",
39343945
},
39353946
"start_year": {
3936-
"description": "Year when the source started publishing.",
3947+
"description": "Year when the source title started publishing.",
39373948
"is_entity": False,
39383949
"is_facet": True,
39393950
"is_filter": True,
@@ -3942,7 +3953,7 @@
39423953
"type": "integer",
39433954
},
39443955
"title": {
3945-
"description": "The title of the source.",
3956+
"description": "The title of the source title.",
39463957
"is_entity": False,
39473958
"is_facet": False,
39483959
"is_filter": False,
@@ -3951,7 +3962,7 @@
39513962
"type": "string",
39523963
},
39533964
"type": {
3954-
"description": "The source type: one of `book_series`, `proceeding`, `journal`, `preprint_platform` (4 in total).",
3965+
"description": "The source title type: one of `book_series`, `proceeding`, `journal`, `preprint_platform` (4 in total).",
39553966
"is_entity": False,
39563967
"is_facet": True,
39573968
"is_filter": True,

0 commit comments

Comments
 (0)