-
Notifications
You must be signed in to change notification settings - Fork 0
/
clarin_fip_metrics_v0.3.yaml
249 lines (242 loc) · 11.7 KB
/
clarin_fip_metrics_v0.3.yaml
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
config:
metric_specification: https://docs.google.com/spreadsheets/d/1hY2zPmFDZ6aIlY-MupK6gvynQZucOxikFDgv5YWxFyQ
metric_version: 0.3
metric_namespaces:
cmd: http://www.clarin.eu/cmd/1
cmdp: http://www.clarin.eu/cmd/1/profiles/clarin.eu:cr1:p_1288172614026
js: http://www.w3.org/2005/xpath-functions
metrics:
- metric_identifier: CLFIP-F1-01M
metric_number: 1
metric_name: "Persistent metadata record identifier"
metric_description: "What globally unique, persistent, resolvable identifiers do you use for metadata records?"
fair_principle: F1
target: Metadata
modality: any
max_score: 2
metric_tests:
- metric_test_identifier: CLFIP-F1-01M-1
metric_test_name: "Check to see if the selflink is a handle"
metric_test_score: 0.5
metric_test_requirements:
- test: "xpath:starts-with(//cmd:MdSelfLink, 'hdl:')"
modality: all
- metric_test_identifier: CLFIP-F1-01M-2
metric_test_name: "Check to see if the selflink is a doi"
metric_test_score: 0.5
metric_test_requirements:
- test: "xpath:starts-with(//cmd:MdSelfLink, 'doi:')"
modality: all
- metric_test_identifier: CLFIP-F1-01M-3
metric_test_name: "Check to see if the selflink is a HTTP handle"
metric_test_score: 0.5
metric_test_requirements:
- test: "xpath:starts-with(//cmd:MdSelfLink, 'http://hdl.handle.net/')"
modality: all
- metric_test_identifier: CLFIP-F1-01M-4
metric_test_name: "Check to see if the selflink is a HTTPS handle"
metric_test_score: 1
metric_test_requirements:
- test: "xpath:starts-with(//cmd:MdSelfLink, 'https://hdl.handle.net/')"
modality: all
- metric_test_identifier: CLFIP-F1-01M-5
metric_test_name: "Check to see if the selflink is a HTTPS doi"
metric_test_score: 2
metric_test_requirements:
- test: "xpath:starts-with(//cmd:MdSelfLink, 'https://doi.org/10.') or starts-with(//cmd:MdSelfLink, 'https://dx.doi.org/10.')"
modality: all
- metric_test_identifier: CLFIP-F1-01M-6
metric_test_name: "Check to see if the selflink is a HTTP doi"
metric_test_score: 0.5
metric_test_requirements:
- test: "xpath:starts-with(//cmd:MdSelfLink, 'http://doi.org/10.')"
modality: all
- metric_identifier: CLFIP-F1-02D
metric_number: 2
metric_name: "Persistent data identifiers"
metric_description: "What globally unique, persistent, resolvable identifiers do you use for datasets?"
fair_principle: F1
target: Data
modality: any
max_score: 1
metric_tests:
- metric_test_identifier: CLFIP-F1-02D-1
metric_test_name: "Check to see if the Resource ResourceProxy is a handle"
metric_test_score: 1
metric_test_requirements:
- test: 'xpath:for-each(//cmd:ResourceProxy[cmd:ResourceType=''Resource'']/cmd:ResourceRef, function($a) { starts-with($a, ''hdl:'') })'
modality: any
- metric_test_identifier: CLFIP-F1-02D-2
metric_test_name: "Check to see if the Resource ResourceProxy is a doi"
metric_test_score: 1
metric_test_requirements:
- test: 'xpath:for-each(//cmd:ResourceProxy[cmd:ResourceType=''Resource'']/cmd:ResourceRef, function($a) { starts-with($a, ''doi:'') })'
modality: any
- metric_test_identifier: CLFIP-F1-02D-3
metric_test_name: "Check to see if the Resource ResourceProxy is a HTTP handle"
metric_test_score: 1
metric_test_requirements:
- test: 'xpath:for-each(//cmd:ResourceProxy[cmd:ResourceType=''Resource'']/cmd:ResourceRef, function($a) { starts-with($a, ''http://hdl.handle.net/'') })'
modality: any
- metric_test_identifier: CLFIP-F1-02D-4
metric_test_name: "Check to see if the Resource ResourceProxy is a HTTPS handle"
metric_test_score: 1
metric_test_requirements:
- test: 'xpath:for-each(//cmd:ResourceProxy[cmd:ResourceType=''Resource'']/cmd:ResourceRef, function($a) { starts-with($a, ''https://hdl.handle.net/'') })'
modality: any
- metric_test_identifier: CLFIP-F1-02D-5
metric_test_name: "Check to see if the Resource ResourceProxy is a HTTPS doi"
metric_test_score: 1
metric_test_requirements:
- test: 'xpath:for-each(//cmd:ResourceProxy[cmd:ResourceType=''Resource'']/cmd:ResourceRef, function($a) { starts-with($a, ''https://doi.org/10.'') })'
modality: any
- metric_test_identifier: CLFIP-F1-02D-6
metric_test_name: "Check to see if the Resource ResourceProxy is a HTTP doi"
metric_test_score: 1
metric_test_requirements:
- test: 'xpath:for-each(//cmd:ResourceProxy[cmd:ResourceType=''Resource'']/cmd:ResourceRef, function($a) { starts-with($a, ''http://doi.org/10.'') })'
modality: any
- metric_test_identifier: CLFIP-F1-02D-7
metric_test_name: "Check to see if the Resource ResourceProxy is a valid URI"
metric_test_score: 0.5
metric_test_requirements:
- test: 'xpath:for-each(//cmd:ResourceProxy[cmd:ResourceType=''Resource'']/cmd:ResourceRef, function($a) { $a castable as xs:anyURI })'
modality: any
- metric_identifier: CLFIP-F2-01M
metric_number: 3
metric_name: "metadata schema for findability"
metric_description: "Which metadata schemas do you use for findability?"
fair_principle: F2
target: Metadata
modality: all
max_score: 4
metric_tests:
- metric_test_identifier: CLFIP-F2-01M-1
metric_test_name: "Facet coverage score of the used CMD profile is larger than .2"
metric_test_score: 1
metric_test_requirements:
- test: "xpath:xs:decimal(replace(unparsed-text(concat('https://curation.clarin.eu/curate?url-input=',encode-for-uri(concat('https://catalog.clarin.eu/ds/ComponentRegistry/rest/registry/1.x/profiles/',//cmd:MdProfile,'/xsd')))),'^.*Facets Section.*? ([0-9]+\\.[0-9]+) / 1.00.*$','$1','sm')) > 0.2"
modality: all
- metric_test_identifier: CLFIP-F2-01M-2
metric_test_name: "Facet coverage score of the used CMD profile is larger than .8"
metric_test_score: 3
metric_test_requirements:
- test: "xpath:xs:decimal(replace(unparsed-text(concat('https://curation.clarin.eu/curate?url-input=',encode-for-uri(concat('https://catalog.clarin.eu/ds/ComponentRegistry/rest/registry/1.x/profiles/',//cmd:MdProfile,'/xsd')))),'^.*Facets Section.*? ([0-9]+\\.[0-9]+) / 1.00.*$','$1','sm')) > 0.8"
modality: all
- metric_identifier: CLFIP-F3-01M
metric_number: 4
metric_name: "metadata linkage technology"
metric_description: "What is the technology that links the persistent identifiers of your data to the metadata description?"
fair_principle: F3
target: Metadata
modality: any
max_score: 1
metric_tests:
# - metric_test_identifier: CLFIP-F3-01M-0
# metric_test_name: "Number of resource proxies"
# metric_test_score: 1
# metric_test_requirements:
# - test: "xpath:if (count(//cmd:ResourceProxy) gt 1) then (1.0) else (if (count(//cmd:ResourceProxy) gt 0) then (0.5) else (0.0))"
# modality: all
- metric_test_identifier: CLFIP-F3-01M-1
metric_test_name: "Multiple resource proxies available"
metric_test_score: 1
metric_test_requirements:
- test: "xpath:(count(//cmd:ResourceProxy) gt 1)"
modality: all
- metric_test_identifier: CLFIP-F3-01M-2
metric_test_name: "One resource proxy avaiable"
metric_test_score: 0.5
metric_test_requirements:
- test: "xpath:(count(//cmd:ResourceProxy) eq 1)"
modality: all
- metric_identifier: CLFIP-F4-01M
metric_number: 5
metric_name: "metadata origin"
metric_description: "In which search engines are your metadata records indexed?"
fair_principle: F4
target: Metadata
modality: any
max_score: 1
metric_tests:
- metric_test_identifier: CLFIP-F4-01M-1
metric_test_name: "CLARIAH partners that are also CLARIN partners"
metric_test_score: 1
metric_test_requirements:
- test: "xpath:$facets/js:map/js:string[@key='_harvesterRoot']='CLARIN Partners'"
variables: [ "facets=json-to-xml($FACETS)" ]
modality: all
- metric_test_identifier: CLFIP-F4-01M-2
metric_test_name: "CLARIAH partners that are also NDE partners"
metric_test_score: 1
metric_test_requirements:
- test: "xpath:$facets//js:map/js:string[@key='_harvesterRoot']='NDE'"
variables: [ "facets=json-to-xml($FACETS)" ]
modality: all
- metric_identifier: CLFIP-F4-02D
metric_number: 6
metric_name: "data search"
metric_description: "In which search engines are your datasets indexed?"
fair_principle: F4
target: Data
modality: all
max_score: 5
metric_tests:
- metric_test_identifier: CLFIP-F4-02D-1
metric_test_name: "search data via a search service"
metric_test_score: 2
metric_test_requirements:
- test: "xpath:exists(//cmd:ResourceProxy[cmd:ResourceType='SearchService'])"
modality: all
- metric_test_identifier: CLFIP-F4-02D-2
metric_test_name: "search data via a search page"
metric_test_score: 3
metric_test_requirements:
- test: "xpath:exists(//cmd:ResourceProxy[cmd:ResourceType='SearchPage'])"
modality: all
- metric_identifier: CLFIP-A1.1-01M
metric_number: 7
metric_name: "metadata communication protocol"
metric_description: "Which standardized communication protocol do you use for metadata records?"
fair_principle: A1.1
target: Metadata
modality: any
max_score: 1
metric_tests:
- metric_test_identifier: CLFIP-A1.1-01M-1
metric_test_name: "all metadata identifiers use HTTPS"
metric_test_score: 1
metric_test_requirements:
- test: "xpath:empty((//cmd:MsSelfLink,//cmd:ResourceProxy[cmd:ResourceType='Metadata']/cmd:ResourceRef)[not(starts-with(.,'https://') or starts-with(.,'doi:') or starts-with(.,'hdl:'))])"
modality: all
- metric_test_identifier: CLFIP-A1.1-01M-2
metric_test_name: "some metadata identifiers use HTTPS"
metric_test_score: 1
metric_test_requirements:
- test: "xpath:exists((//cmd:MsSelfLink,//cmd:ResourceProxy[cmd:ResourceType='Metadata']/cmd:ResourceRef)[starts-with(.,'https://') or starts-with(.,'doi:') or starts-with(.,'hdl:')])"
modality: all
- metric_identifier: CLFIP-A1.1-02D
metric_number: 8
metric_name: "data communication protocol"
metric_description: "Which standardized communication protocol do you use for datasets?"
fair_principle: A1.1
target: Data
modality: any
max_score: 1
metric_tests:
- metric_test_identifier: CLFIP-A1.1-02D-1
metric_test_name: "all data identifiers use HTTPS"
metric_test_score: 1
metric_test_requirements:
- test: "xpath:empty(//cmd:ResourceProxy[cmd:ResourceType='Resource']/cmd:ResourceRef[not(starts-with(.,'https://') or starts-with(.,'doi:') or starts-with(.,'hdl:'))])"
modality: all
- metric_test_identifier: CLFIP-A1.1-02D-2
metric_test_name: "some data identifiers use HTTPS"
metric_test_score: 1
metric_test_requirements:
- test: "xpath:exists(//cmd:ResourceProxy[cmd:ResourceType='Resource']/cmd:ResourceRef[starts-with(.,'https://') or starts-with(.,'doi:') or starts-with(.,'hdl:')])"
modality: all
created_by: CLARIAH-FIP
date_created: 2023-03-01
date_updated: 2024-05-16
version: 0.3