softwaresaved / fuji

FAIRsFAIR Research Data Object Assessment Service
MIT License
0 stars 1 forks source link

[Feature]: [FRSM-12] Does the software provide references to other objects that support its use? #13

Open karacolada opened 7 months ago

karacolada commented 7 months ago

D5.2 p19+p29

Detailed Description

Determining the usefulness of a piece of software is often aided by understanding what it is used with.

Domain-agnostic comments

This metric is currently difficult to implement as there is no standard machine-readable way to define the relationships at a level of detail that provides suitable meaning, although CodeMeta defines some of these relationships (e.g. supportingData, referencePublication) (see docs).

CESSDA comments

CESSDA uses the “docs-as-code” approach for end user and content editor demonstration. Therefore, for this metric, it is hard for CESSDA tools and services to demonstrate compliance. Therefore, this metric is not useful to assess at present. At present, CESSDA does not require publications describing the software - if this changed, a suitable assessment for this metric would be to test the identifier for the publication to be included in the software metadata.

Context

I2: Software includes qualified references to other objects.

domain-agnostic

requirements Software source code, Software identifier
method Check if the software metadata includes references to other related resources.
essential n/a
important The software metadata includes machine-readable references to articles describing the software, articles demonstrating use of the software, or to the data it uses.
useful n/a

CESSDA

requirements
method Not applicable for CESSDA
essential n/a
important n/a
useful n/a
karacolada commented 1 month ago

Extend related resources evaluator: https://github.com/softwaresaved/fuji/blob/1778e730c80852f691e135a1b288bc2796914c46/fuji_server/evaluators/fair_evaluator_related_resources.py#L11