Skip to content

Commit 77dc0cf

Browse files
Anas-ElhounsriAnas-Elhounsri
committed
Minor updates to the report json_ld and examples updates to reflect the latest changes
1 parent d1456f0 commit 77dc0cf

5 files changed

Lines changed: 433 additions & 579 deletions

File tree

‎data/examples/analysis_results_example.json‎

Lines changed: 263 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,263 @@
1+
{
2+
"summary": {
3+
"total_repositories_analyzed": 1,
4+
"repositories_with_target_languages": 1,
5+
"individual_jsonld_files_created": 1,
6+
"total_pitfalls_detected": 3,
7+
"total_warnings_detected": 0,
8+
"target_languages": [
9+
"Python",
10+
"Java",
11+
"C++",
12+
"C",
13+
"R",
14+
"Rust"
15+
],
16+
"evaluated_repositories": {
17+
"tidyverse/tidyverse": {
18+
"url": "https://github.com/tidyverse/tidyverse",
19+
"commit_id": "0231aafbc56914ee5371dd6c7b60677f168d7154"
20+
}
21+
}
22+
},
23+
"pitfalls & warnings": [
24+
{
25+
"pitfall_code": "P001",
26+
"pitfall_desc": "The metadata file (codemeta or other) has a version which does not correspond to the version used in the latest release",
27+
"count": 1,
28+
"percentage": 100.0,
29+
"languages": {
30+
"R": 1
31+
},
32+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P001"
33+
},
34+
{
35+
"pitfall_code": "P002",
36+
"pitfall_desc": "LICENSE file contains template placeholders like <program>, <year>, <name of author> that were not replaced",
37+
"count": 0,
38+
"percentage": 0.0,
39+
"languages": {},
40+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P002"
41+
},
42+
{
43+
"pitfall_code": "P003",
44+
"pitfall_desc": "Metadata files have multiple authors in single field instead of a list",
45+
"count": 1,
46+
"percentage": 100.0,
47+
"languages": {
48+
"R": 1
49+
},
50+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P003"
51+
},
52+
{
53+
"pitfall_code": "P004",
54+
"pitfall_desc": "In codemeta.json README property pointing to their homepage/wiki instead of README file",
55+
"count": 0,
56+
"percentage": 0.0,
57+
"languages": {},
58+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P004"
59+
},
60+
{
61+
"pitfall_code": "P005",
62+
"pitfall_desc": "codemeta.json referencePublication refers to software archive instead of paper",
63+
"count": 0,
64+
"percentage": 0.0,
65+
"languages": {},
66+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P005"
67+
},
68+
{
69+
"pitfall_code": "P006",
70+
"pitfall_desc": "The metadata file has License pointing to a local file instead of stating the name",
71+
"count": 0,
72+
"percentage": 0.0,
73+
"languages": {},
74+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P006"
75+
},
76+
{
77+
"pitfall_code": "P007",
78+
"pitfall_desc": "CITATION.cff does not have referencePublication even though it's referenced in codemeta.json",
79+
"count": 0,
80+
"percentage": 0.0,
81+
"languages": {},
82+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P007"
83+
},
84+
{
85+
"pitfall_code": "P008",
86+
"pitfall_desc": "The metadata file softwareRequirement points to an invalid page",
87+
"count": 0,
88+
"percentage": 0.0,
89+
"languages": {},
90+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P008"
91+
},
92+
{
93+
"pitfall_code": "P009",
94+
"pitfall_desc": "The metadata file coderepository points to their homepage",
95+
"count": 0,
96+
"percentage": 0.0,
97+
"languages": {},
98+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P009"
99+
},
100+
{
101+
"pitfall_code": "P010",
102+
"pitfall_desc": "LICENSE file only contains copyright information without actual license terms",
103+
"count": 0,
104+
"percentage": 0.0,
105+
"languages": {},
106+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P010"
107+
},
108+
{
109+
"pitfall_code": "P011",
110+
"pitfall_desc": "codemeta.json IssueTracker violates the expected URL format",
111+
"count": 0,
112+
"percentage": 0.0,
113+
"languages": {},
114+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P011"
115+
},
116+
{
117+
"pitfall_code": "P012",
118+
"pitfall_desc": "codemeta.json downloadURL is outdated",
119+
"count": 0,
120+
"percentage": 0.0,
121+
"languages": {},
122+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P012"
123+
},
124+
{
125+
"pitfall_code": "P013",
126+
"pitfall_desc": "The metadata file License does not have the specific version",
127+
"count": 0,
128+
"percentage": 0.0,
129+
"languages": {},
130+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P013"
131+
},
132+
{
133+
"pitfall_code": "P014",
134+
"pitfall_desc": "codemeta.json uses bare DOIs in the identifier field instead of full https://doi.org/ URL",
135+
"count": 0,
136+
"percentage": 0.0,
137+
"languages": {},
138+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P014"
139+
},
140+
{
141+
"pitfall_code": "P015",
142+
"pitfall_desc": "In codemeta.json contIntegration link returns 404",
143+
"count": 0,
144+
"percentage": 0.0,
145+
"languages": {},
146+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P015"
147+
},
148+
{
149+
"pitfall_code": "P016",
150+
"pitfall_desc": "The metadata file codeRepository does not point to the same repository",
151+
"count": 0,
152+
"percentage": 0.0,
153+
"languages": {},
154+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P016"
155+
},
156+
{
157+
"pitfall_code": "P017",
158+
"pitfall_desc": "codemeta.json version does not match the package's",
159+
"count": 1,
160+
"percentage": 100.0,
161+
"languages": {
162+
"R": 1
163+
},
164+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P017"
165+
},
166+
{
167+
"pitfall_code": "P018",
168+
"pitfall_desc": "codemeta.json Identifier uses raw SWHIDs without their resolvable URL",
169+
"count": 0,
170+
"percentage": 0.0,
171+
"languages": {},
172+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P018"
173+
},
174+
{
175+
"pitfall_code": "P019",
176+
"pitfall_desc": "Inconsistent author counts found across metadata files",
177+
"count": 0,
178+
"percentage": 0.0,
179+
"languages": {},
180+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#P019"
181+
},
182+
{
183+
"warning_code": "W001",
184+
"warning_desc": "Software requirements in metadata files don't have version specifications",
185+
"count": 0,
186+
"percentage": 0.0,
187+
"languages": {},
188+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#W001"
189+
},
190+
{
191+
"warning_code": "W002",
192+
"warning_desc": "The dateModified in codemeta.json is outdated compared to the actual repository last update date",
193+
"count": 0,
194+
"percentage": 0.0,
195+
"languages": {},
196+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#W002"
197+
},
198+
{
199+
"warning_code": "W003",
200+
"warning_desc": "Codemeta.json repository has multiple licenses but only one is listed",
201+
"count": 0,
202+
"percentage": 0.0,
203+
"languages": {},
204+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#W003"
205+
},
206+
{
207+
"warning_code": "W004",
208+
"warning_desc": "Programming languages in codemeta.json do not have versions",
209+
"count": 0,
210+
"percentage": 0.0,
211+
"languages": {},
212+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#W004"
213+
},
214+
{
215+
"warning_code": "W005",
216+
"warning_desc": "The metadata file softwareRequirements have more than one req, but it's written as one string",
217+
"count": 0,
218+
"percentage": 0.0,
219+
"languages": {},
220+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#W005"
221+
},
222+
{
223+
"warning_code": "W006",
224+
"warning_desc": "codemeta.json Identifier is a name instead of a valid unique identifier, but an identifier exist",
225+
"count": 0,
226+
"percentage": 0.0,
227+
"languages": {},
228+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#W006"
229+
},
230+
{
231+
"warning_code": "W007",
232+
"warning_desc": "codemeta.json Identifier is empty",
233+
"count": 0,
234+
"percentage": 0.0,
235+
"languages": {},
236+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#W007"
237+
},
238+
{
239+
"warning_code": "W008",
240+
"warning_desc": "The metadata file GivenName is a list instead of a string",
241+
"count": 0,
242+
"percentage": 0.0,
243+
"languages": {},
244+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#W008"
245+
},
246+
{
247+
"pitfall_code": "W009",
248+
"pitfall_desc": "codemeta.json developmentStatus is a URL instead of a string",
249+
"count": 0,
250+
"percentage": 0.0,
251+
"languages": {},
252+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#W009"
253+
},
254+
{
255+
"pitfall_code": "W010",
256+
"pitfall_desc": "The metadata file codeRepository uses Git remote-style shorthand instead of full URL",
257+
"count": 0,
258+
"percentage": 0.0,
259+
"languages": {},
260+
"pitfall": "https://w3id.org/rsmetacheck/catalog/#W010"
261+
}
262+
]
263+
}

0 commit comments

Comments
 (0)