FAIR Champion Logo

124 Tests Available in the Registry

Generic CURL command:

  curl -H "Accept: application/json" https://tools.ostrails.eu/champion/tests
          

FAIR Champion: Data Authorization

Test a discovered data GUID for the ability to implement authentication and authorization in its resolution protocol. Currently passes InChI Keys, DOIs, Handles, and URLs. It also searches the metadata for the Dublin Core 'accessRights' property, which may point to a document describing the data access process. Recognition of other identifiers will be added upon request by the community.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.8e0027
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.VrP6sm

FAIR Champion: Data Identifier in Metadata

Test that the identifier of the data is an unambiguous element of the metadata. Tested options are schema:distribution, http://www.w3.org/ns/ldp#contains, iao:IAO_0000136, IAO:0000136,ldp:contains,foaf:primaryTopic,schema:distribution,schema:contentUrl,schema,mainEntity,schema:codeRepository,schema:distribution,schema:contentUrl, dcat:distribution, dcat:dataset,dcat:downloadURL,dcat:accessURL,sio:SIO_000332, sio:is-about, obo:IAO_0000136

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.820324
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.5Xy1dJ

FAIR Champion: Data Knowlege Representation Language (Strict Test)

Test if the data uses a formal language broadly applicable for knowledge representation. This particular test takes a broad view of what defines a 'knowledge representation language'; in this evaluation, a knowledge representation language is interpreted as one in which terms are semantically-grounded in ontologies. Any form of ontologically-grounded linked data will pass this test.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.ec5648
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.l8fVBn

FAIR Champion: Data Knowlege Representation Language (Weak Test)

Test if the data uses a formal language broadly applicable for knowledge representation. This particular test takes a broad view of what defines a 'knowledge representation language'; in this evaluation, a knowledge representation language is interpreted as one in which terms are semantically-grounded in ontologies. Any form of structured data will pass this test

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.ec5648
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.qUroF6

FAIR Champion: Data Protocol

Data may be retrieved by an open and free protocol. Tests data GUID for its resolution protocol. Currently passes InChI Keys, DOIs, Handles, and URLs. Recognition of other identifiers will be added upon request by the community.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.7612c1
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.DfMGZW

FAIR Champion: Grounded Metadata

Tests whether a machine is able to find 'grounded' metadata. i.e. metadata terms that are in a resolvable namespace, where resolution leads to a definition of the meaning of the term. Examples include JSON-LD, embedded schema, or any form of RDF. This test currently excludes XML, even when terms are namespaced. Future versions of this test may be more flexible.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.e05e98
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.lXAOu2

FAIR Champion: Metadata Authorization

Tests metadata GUID for the ability to implement authentication and authorization in its resolution protocol. Currently passes InChI Keys, DOIs, Handles, and URLs. Recognition of other identifiers will be added upon request by the community.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.8e0027
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.VrP6sm

FAIR Champion: Metadata Identifier Explicitly In Metadata

Metric to test if the metadata contains the unique identifier to the metadata itself. This is done using a variety of 'scraping' tools, including DOI metadata resolution, the use of the 'extruct' Python tool, and others. The test is executed by searching for the predicates 'http[s]://purl.org/dc/terms/identifier','http[s]://schema.org/identifier.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.820324
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.5Xy1dJ

FAIR Champion: Identifier Persistence

Metric to test if the unique identifier of the metadata resource is likely to be persistent. Known schema are registered in FAIRSharing (https://fairsharing.org/standards/?q=&selected_facets=type_exact:identifier%20schema). For URLs that don't follow a schema in FAIRSharing we test known URL persistence schemas (purl, oclc, fdlp, purlz, w3id, ark).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.e226cb
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.VRo9Dl

FAIR Champion: Metadata Includes License (strong)

Maturity Indicator to test if the linked data metadata contains an explicit pointer to the license. Tests: xhtml, dvia, dcterms, cc, data.gov.au, and Schema license predicates in linked data, and validates the value of those properties.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.8e0027
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.VrP6sm

FAIR Champion: Metadata Includes License (weak)

Maturity Indicator to test if the metadata contains an explicit pointer to the license. This 'weak' test will use a case-insensitive regular expression, and scan both key/value style metadata, as well as linked data metadata. Tests: xhtml, dvia, dcterms, cc, data.gov.au, and Schema license predicates in linked data, and validates the value of those properties.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.aff99f
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.YAdSwh

FAIR Champion: Metadata Knowledge Representation Language (weak)

Maturity Indicator to test if the metadata uses a formal language broadly applicable for knowledge representation. This particular test takes a broad view of what defines a 'knowledge representation language'; in this evaluation, anything that can be represented as structured data will be accepted.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.ec5648
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.qUroF6

FAIR Champion: Metadata Contains Outward Links

Maturity Indicator to test if the metadata links outward to third-party resources. It only tests metadata that can be represented as Linked Data.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.ae22b8
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.LLXjWx

FAIR Champion: Metadata Persistence

Metric to test if the metadata contains a persistence policy, explicitly identified by a persistencePolicy key (in hashed data) or a http://www.w3.org/2000/10/swap/pim/doc#persistencePolicy predicate in Linked Data.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.7c4d7f
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.lEZbPK

FAIR Champion: Uses open free protocol for metadata retrieval

Metadata may be retrieved by an open and free protocol. Tests metadata GUID for its resolution protocol. Currently passes InChI Keys, DOIs, Handles, and URLs. Recognition of other identifiers will be added upon request by the community.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.7612c1
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.DfMGZW

FAIR Champion: Metadata uses FAIR vocabularies (strong)

Maturity Indicator to test if the linked data metadata uses terms that resolve to linked (FAIR) data.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.96d4af
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.RCUuvt

FAIR Champion: Searchable in major search engine

Tests whether a machine is able to discover the resource by search, using Microsoft Bing.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.0c0d21
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.x1f1l4

FAIR Champion: Structured Metadata

Tests whether a machine is able to find structured metadata. This could be (for example) RDFa, embedded json, json-ld, or content-negotiated structured metadata such as RDF Turtle.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.e05e98
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.2dUpZs

FAIR Champion: Unique Identifier

Metric to test if the metadata resource has a unique identifier. This is done by comparing the GUID to the patterns (by regexp) of known GUID schemas such as URLs and DOIs. Known schema are registered in FAIRSharing (https://fairsharing.org/standards/?q=&selected_facets=type_exact:identifier%20schema)

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.b7f1ab
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.NHCOKK

Ontology minimum metadata is declared

This check verifies if the following minimum metadata are present in the ontology metadata: * title: declared using [dc:title](http://purl.org/dc/elements/1.1/title), [dcterms:title](http://purl.org/dc/terms/title) or [schema:name](http://schema.org/name) * description: declared using [dc:abstract](http://purl.org/dc/elements/1.1/abstract), [dcterms:abstract](http://purl.org/dc/terms/abstract), [dc:description](http://purl.org/dc/elements/1.1/description), [dcterms:description](http://purl.org/dc/terms/description), [schema:description](http://schema.org/description), [rdfs:comment](http://www.w3.org/2000/01/rdf-schema#comment), [doap:description](http://usefulinc.com/ns/doap#description), [doap:shortdesc](http://usefulinc.com/ns/doap#shortdesc) or [skos:note](http://www.w3.org/2004/02/skos/core#note) * license: declared using [dcterms:license](http://purl.org/dc/terms/license), [schema:license](http://schema.org/licesne), [doap:license](http://usefulinc.com/ns/doap#license) or [cc:license](http://creativecommons.org/ns#license). * version iri: declared using [owl:versionIRI](http://www.w3.org/2002/07/owl#versionIRI) * creator: declared using [dc:creator](http://purl.org/dc/elements/1.1/creator), [dcterms:creator](http://purl.org/dc/terms/creator), [pav:createdBy](http://purl.org/pav/createdBy), [pav:authoredBy](http://purl.org/pav/authoredBy), [schema:creator](http://schema.org/creator), [prov:wasAttributedTo](http://www.w3.org/ns/prov#wasAttributedTo) or [doap:developer](http://usefulinc.com/ns/doap#developer) * namespace URI: declared using [vann:preferredNamespaceUri](https://purl.org/vocab/vann/) The test will pass if all ontology metadata are present. The test will fail otherwise, indicating the properties that are missing.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/F2
Domain
Benchmark or Metric https://w3id.org/foops/metric/OM1

Ontology has a persistent URL

This test verifies if the ontology has a persistent URL. We do so by checking if the ontology URI follows any of the following URI schemes: * w3id.org * doi.org * purl.org (or purl.something.org) * linked.data.gov.au * dbpedia.org * www.w3.org * perma.cc * data.europa.eu

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/F1
Domain
Benchmark or Metric https://w3id.org/foops/metric/PURL1

Ontology uses an open protocol

This check verifies if the ontology uses an open protocol (HTTP or HTTPS). The test will pass if the ontology URI starts with http or https. It will fail otherwise.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/A1.1
Domain
Benchmark or Metric https://w3id.org/foops/metric/HTTP1

A version IRI is declared in the ontology metadata

This test verifies whether there is an id for this ontology version, and whether the id is unique (i.e., different from the ontology URI). The test will pass if: 1. The ontology has a versionIRI ([owl:versionIRI](http://www.w3.org/2002/07/owl#versionIRI)) and 2. The versionIRI used is different from the ontology URI. Otherwise the test will fail. The test will also verify whether version information is present (through [owl:versionInfo](http://www.w3.org/2002/07/owl#versionInfo)), but this is optional.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/F1
Domain
Benchmark or Metric https://w3id.org/foops/metric/VER1

Ontology URI is resolvable

This test verifies if the ontology URI that was found within the ontology document is resolvable. Note that the ontology URI found in the ontology may be different from the URI used in the assessment. The test will pass if the vocabulary is resolvable in any of the following RDF serializations: RDF/XML, TTL, N-Triples, JSON-LD. The test will fail if no known RDF serialization is returned, or the serialization returned is not among one of the aforementioned.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/F1
Domain
Benchmark or Metric https://w3id.org/foops/metric/URI1

Ontology has a license available

This test verifies if a license (or rights) are associated with the ontology. The test will pass if a license is declared using any of the following properties: [dcterms:license](http://purl.org/dc/terms/license), [schema:license](https://schema.org/license), [doap:license](http://usefulinc.com/ns/doap#license) or [cc:license](http://creativecommons.org/ns#license). If a license is not found, but rights are declared (using [dc:rights](http://purl.org/dc/elements/1.1/rights), [dcterms:rights](http://purl.org/dc/terms/rights) or [dcterms:accessRights](http://purl.org/dc/terms/accessRights)), the test will pass as well. Otherwise, the test will fail (i.e., no license or rights are declared).

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/R1.1
Domain
Benchmark or Metric https://w3id.org/foops/metric/OM4.1

Ontology reuses existing vocabularies for metadata annotations

This test verifies if the ontology reuses other vocabularies for declaring metadata terms (see tests OM1... OM5). The test will pass if metadata annotations using properties from any of the following vocabularies are used: * [Dublin Core](http://purl.org/dc/elements/1.1/) (dc, dcterms) * [Schema.org](https://schema.org/) (schema) * [Vocabulary for annotating vocabulary descriptions](http://purl.org/vocab/vann/) (vann) * [W3C Provenance standard](http://www.w3.org/ns/prov#) (prov) * [Bibliographic Ontology](http://purl.org/ontology/bibo/) (bibo) * [Provenance, Authoring and Versioning](http://purl.org/pav/) (pav) * [Firend of a friend](http://xmlns.com/foaf/0.1/) (foaf) * [Description of a project](http://usefulinc.com/ns/doap#) (doap) * [Metadata vocabulary for ontology descriptions](https://w3id.org/mod#) (mod) * [Web Ontology Language](http://www.w3.org/2002/07/owl#) (owl) * [Resource description framework schema](http://www.w3.org/2000/01/rdf-schema#) (rdfs) The test will also return the vocabularies that were found. If none are found, the test will fail.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/I2
Domain
Benchmark or Metric https://w3id.org/foops/metric/VOC1

Ontology prefix is found in prefix.cc or LOV

This test verifies whether the ontology prefix is available in [prefix.cc]((https://prefix.cc/)) or the [Linked Open Vocabularies (LOV)]((https://lov.linkeddata.es/)) registries. The test will pass if: 1. there is a prefix declared in the assessed ontology, 2. the prefix is found in [LOV](https://lov.linkeddata.es/) or [prefix.cc](https://prefix.cc/) 3. if found in [LOV](https://lov.linkeddata.es/) or [prefix.cc](https://prefix.cc/) , the namespace URI associated with the prefix is the same as the assessed ontology URI (or preferred namespace URI) Otherwise, the test will fail.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/F4
Domain
Benchmark or Metric https://w3id.org/foops/metric/FIND2

Ontology found in community registry

This test verifies if the ontology can be found in a public registry like the Linked Open Vocabularies (LOV) public registry. The test will pass if the assessed ontology URI is found in the list of vocabularies returned by LOV. Alternatively, if there is a [schema:includedInDataCatalog](https://schema.org/includedInDataCatalog) annotation, the test will pass. The test will fail otherwise.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/F4
Domain
Benchmark or Metric https://w3id.org/foops/metric/FIND3

Ontology is available in RDF (TTL, N3, RDF/XML or JSON-LD)

This test verifies if the ontology has a valid RDF serialization (TTL, N3, RDF/XML or JSON-LD are supported). The test will fail if no RDF serialization could be loaded for analysis (e.g., the ontology has typos that prevent its parsing). The test uses the OWLAPI to load ontologies or vocabularies.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/I1
Domain
Benchmark or Metric https://w3id.org/foops/metric/RDF1

Ontology declares detailed provenance metadata

This check verifies if detailed provenance information is available for the ontology: * issued date: declared using [dcterms:issued](http://purl.org/dc/terms/issued), [dcterms:submitted](http://purl.org/dc/terms/submitted) or [schema:datePublished](https://schema.org/datePublished) * publisher: declared using [dc:publisher](http://purl.org/dc/elements/1.1/publisher), [dcterms:publisher](http://purl.org/dc/terms/publisher) or [schema:publisher](https://schema.org/publisher) The test will pass if both metadata fields are present. The test will fail otherwise, indicating the properties that are missing.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/R1.2
Domain
Benchmark or Metric https://w3id.org/foops/metric/OM5.2

Ontology has HTML documentation

This test verifies if the ontology has an HTML documentation. The test will attempt to download an HTML representation using the ontology URI, with content negotiation

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/R1
Domain
Benchmark or Metric https://w3id.org/foops/metric/DOC1

Ontology declares recommended metadata

This test verifies if the following recommended metadata are present in the ontology metadata: * Namespace prefix: declared using [vann:preferredNamespacePrefix](https://purl.org/vocab/vann/) * Version info: declared using [owl:versionInfo](http://www.w3.org/2002/07/owl#versionInfo) or [schema:schemaVersion](http://schema.org/schemaVersion) * Creation date: declared using [dcterms:created](http://purl.org/dc/terms/created), [schema:dateCreated](http://schema.org/dateCreated), [doap:created](http://usefulinc.com/ns/doap#created), [prov:generatedAtTime](http://www.w3.org/ns/prov#generatedAtTime) or [pav:createdOn](http://purl.org/pav/) * Citation: declared using [dcterms:bibliographicCitation](http://purl.org/dc/terms/bibliographicCitation) * Contributor (optional): declared using [dc:contributor](http://purl.org/dc/elements/1.1/contributor), [dcterms:contributor](http://purl.org/dc/terms/contributor), schema:contributor, [doap:documenter](http://usefulinc.com/ns/doap#documenter), [doap:maintainer](http://usefulinc.com/ns/doap#maintainer), [doap:helper](http://usefulinc.com/ns/doap#helper), [doap:translator](http://usefulinc.com/ns/doap#translator) or [pav:contributedBy](http://purl.org/pav/). The test will pass if all the recommended metadata properties are available in the ontology metadata (using any of the vocabularies listed above). The test will also check if contributor is present, but with no penalty (as not all ontologies have a contributor).

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/R1
Domain
Benchmark or Metric https://w3id.org/foops/metric/OM2

Ontology has content negotiation for RDF in RDF/XML, TTL, NTriples or JSON-LD serializations

This test verifies whether HTML and an RDF representation is available for the target vocabulary by doing content negotiation on the ontology URI. The test will pass if the vocabulary is available in HTML and in any of the following RDF serializations: * RDF/XML (application/rdf+xml), * TTL (text/turtle), * N-Triples (text/n3), * JSON-LD (application/ld+json) The test will fail if no HTML is returned, if no known RDF serialization is returned, or the serialization returned is not among one of the aforementioned.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/A1
Domain
Benchmark or Metric https://w3id.org/foops/metric/CN1

Ontology declares detailed metadata

This test verifies if the ontology includes the following detailed metadata: * Digital Object Identifier (DOI): declared using [bibo:doi](http://purl.org/ontology/bibo/doi), [schema:identifier](https://schema.org/identifier) (if a doi is provided) or [dcterms:identifier](http://purl.org/dc/terms/identifier) (if a doi is provided) * publisher: declared using [dc:publisher](http://purl.org/dc/elements/1.1/publisher), [dcterms:publisher](http://purl.org/dc/terms/publisher) or [schema:publisher](https://schema.org/publisher) * logo: declared using [foaf:logo](http://xmlns.com/foaf/0.1/logo) or [schema:logo](https://schema.org/logo) * status: declared using [bibo:status](http://purl.org/ontology/bibo/status) or [mod:status](https://w3id.org/mod#status) * source: declared using [dcterms:source](http://purl.org/dc/terms/source) or [prov:hadOriginalSource](http://www.w3.org/ns/prov#hadOriginalSource) * issued date: declared using [dcterms:issued](http://purl.org/dc/terms/issued) * previous version (optional): declared using [dc:replaces](http://purl.org/dc/elements/1.1/replaces), [dcterms:replaces](http://purl.org/dc/terms/replaces), [prov:wasRevisionOf](http://www.w3.org/ns/prov#wasRevisionOf), [owl:priorVersion](http://www.w3.org/2002/07/owl#priorVersion) or [pav:previousVersion](http://purl.org/pav/previousVersion) * backward compatibility (optional): declared using [owl:backwardCompatibleWith](http://www.w3.org/2002/07/owl#backwardCompatibleWith) * modified date (optional): declared using [dcterms:modified](http://purl.org/dc/terms/modified) or [schema:dateModified](https://schema.org/dateModified) The test will pass if all the detailed metadata properties are available in the ontology metadata (using any of the vocabularies listed above). The test will also check if previosu version, backward compatibility and modified date are present, but with no penalty (as not all ontologies have a previous version).

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/R1
Domain
Benchmark or Metric https://w3id.org/foops/metric/OM3

Ontology version IRI resolves

This test verifies if the version IRI resolves. The test will pass if there is a version IRI for the ontology/vocabulary (detected using [owl:versionIRI](http://www.w3.org/2002/07/owl#versionIRI) in the ontology metadata) and whether doing a request to said IRI returns a resource. The test will fail if the resource is not found (404 response) or returns an error.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/F1
Domain
Benchmark or Metric https://w3id.org/foops/metric/VER2

Ontology documentation: all terms have labels

This test verifies the extent to which all ontology terms have labels. The test will pass if all classes, properties and data properties have either an [rdfs:label](http://www.w3.org/2000/01/rdf-schema#label) or [skos:prefLabel](http://www.w3.org/2004/02/skos/core#prefLabel). For skos vocabularies, only the skos:Concepts are assessed. Otherwise, the test will fail, indicating the level of completeness found (i.e., percentage of documented terms)

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/R1
Domain
Benchmark or Metric https://w3id.org/foops/metric/VOC3

Ontology documentation: all terms have definitions

This check verifies whether all ontology terms have descriptions. The test will pass if all classes, properties and data properties have at least one [rdfs:comment](http://www.w3.org/2000/01/rdf-schema#comment), [skos:definition](http://www.w3.org/2004/02/skos/core#definition) or [obo:IAO_0000118](http://purl.obolibrary.org/obo/IAO_0000118) annotation. For skos vocabularies, only the skos:Concepts are assessed. The test will fail otherwise, showing the level of completeness obtained (i.e. the percentage of documented terms).

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/R1
Domain
Benchmark or Metric https://w3id.org/foops/metric/VOC4

Ontology license is resolvable

This test verifies if the ontology license is resolvable. The test will pass if the license available in the ontology metadata resolves to a resource. The test will fail if no license is declared (OM4.1), if the license is not a URI/URL, or if the response when requesting is 404 or an error.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/R1.1
Domain
Benchmark or Metric https://w3id.org/foops/metric/OM4.2

Consistent ontology IDs are employed

This check verifies if the ontology URI is equal to the ontology ID. The test passes if the ontology URI used to load the ontology document is the same as the ontology id found in the document itself. Otherwise the test will fail.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/F1
Domain
Benchmark or Metric https://w3id.org/foops/metric/URI2

Ontology imports or reuses well established vocabularies

This test verifies if the ontology imports/extends other vocabularies (besides RDF, OWL and RDFS). The test will pass if other vocabularies are imported ([owl:imports](http://www.w3.org/2002/07/owl#imports)), or if classes, properties or data properties outside the ontology URI or namespace URI are used. The test wil fail if no terms are reused.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/I2
Domain
Benchmark or Metric https://w3id.org/foops/metric/VOC2

Ontology metadata are accessible, even when the ontology is not

Metadata are accessible even when the ontology is no longer available. Since the metadata is usually included in the ontology, this test verifies if the ontology can be found in the [Linked Open Vocabularies (LOV) public registry](https://lov.linkeddata.es). The test will pass if the assessed ontology/vocabulary URI is found in the LOV list of vocabularies. Alternatively, if there is a [schema:includedInDataCatalog](https://schema.org/includedInDataCatalog) annotation, the test will pass. The test will fail otherwise.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/A2
Domain
Benchmark or Metric https://w3id.org/foops/metric/FIND_3_BIS

Ontology prefix is declared

This check verifies if an ontology prefix is declared in the ontology metadata. The test will pass if a [vann:preferredNamespacePrefix](http://purl.org/vocab/vann/) is declared. Otherwise, the test will fail.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/F3
Domain
Benchmark or Metric https://w3id.org/foops/metric/FIND1

Ontology declares basic provenance metadata

This check verifies if basic provenance metadata is available for the ontology: * creator: declared using [dc:creator](http://purl.org/dc/elements/1.1/creator), [dcterms:creator](http://purl.org/dc/terms/creator), [pav:createdBy](http://purl.org/pav/createdBy), [pav:authoredBy](http://purl.org/pav/authoredBy), [schema:creator](https://schema.org/creator) or [doap:developer](http://usefulinc.com/ns/doap#developer) * creation date: declared using [dcterms:created](http://purl.org/dc/terms/created), [schema:dateCreated](https://schema.org/dateCreated), [doap:created](http://usefulinc.com/ns/doap#created), [prov:generatedAtTime](http://www.w3.org/ns/prov#generatedAtTime) or [pav:createdOn](http://purl.org/pav/createdOn) * contributor (optional): declared using [dc:contributor](http://purl.org/dc/elements/1.1/contributor), [dcterms:contributor](http://purl.org/dc/terms/contributor), [schema:contributor](https://schema.org/contributor), [doap:documenter](http://usefulinc.com/ns/doap#documenter), [doap:maintainer](http://usefulinc.com/ns/doap#maintainer), [doap:helper](http://usefulinc.com/ns/doap#helper), [doap:translator](http://usefulinc.com/ns/doap#translator) or [pav:contributedBy](http://purl.org/pav/contributedBy). * previous version (optional): declared using [dc:replaces](http://purl.org/dc/elements/1.1/replaces), [dcterms:replaces](http://purl.org/dc/terms/replaces), [prov:wasRevisionOf](http://www.w3.org/ns/prov#wasRevisionOf), [owl:priorVersion](http://www.w3.org/2002/07/owl#previousVersion), [pav:previousVersion](http://purl.org/pav/previousVersion) The test will pass if creator and creation date are present. The test will fail otherwise, indicating the properties that are missing.

API Definition

Additional Details
Dimension https://w3id.org/fair/principles/terms/R1.2
Domain
Benchmark or Metric https://w3id.org/foops/metric/OM5.1

FAIR Champion: Metadata Knowledge Representation Language (strong)

Maturity Indicator to test if the metadata uses a formal language broadly applicable for knowledge representation. This particular test takes a broad view of what defines a 'knowledge representation language'; in this evaluation, a knowledge representation language is interpreted as one in which terms are semantically-grounded in ontologies. Any form of RDF will pass this test (including RDF that is automatically extracted by third-party parsers such as Apache Tika).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.ec5648
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.l8fVBn

Software identifier follows a proper schema

This test checks that the identifier associated with a software (if there’s one) follows a common schema such as URN, URL, DOI, etc. This is achieved by looking for identifiers in the README file and checking if they follow one of these schemas: URN, SWHID,, DOI and URL.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/persistent_and_unique_identifier

Software identifier follows a proper schema

This test checks that the identifier associated with a software (if there’s one) follows a common schema such as URN, URL, DOI, etc. This is achieved by looking for identifiers in the README file and checking if they follow one of these schemas: URN, SWHID,, DOI and URL.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.99299d
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/persistent_and_unique_identifier

There is an identifier in README or CITATION.cff

This test checks if an identifier is found in the README or CITATION.cff files. This is done by looking for an identifier in the CITATION.cff and README files in the root of the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/persistent_and_unique_identifier

There is an identifier in README or CITATION.cff

This test checks if an identifier is found in the README or CITATION.cff files. This is done by looking for an identifier in the CITATION.cff and README files in the root of the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9d893d
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/persistent_and_unique_identifier

There is contact and/or support metadata

This test checks if contact and/or support metadata is found in the repository. This is achieved by checking if there is contact or support information in the README file or any other package file ( (e.g., setup.py, setup.cfg, pom.xml, etc.).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

There is contact and/or support metadata

This test checks if contact and/or support metadata is found in the repository. This is achieved by checking if there is contact or support information in the README file or any other package file ( (e.g., setup.py, setup.cfg, pom.xml, etc.).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

There is contact and/or support metadata

This test checks if contact and/or support metadata is found in the repository. This is achieved by checking if there is contact or support information in the README file or any other package file ( (e.g., setup.py, setup.cfg, pom.xml, etc.).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.a712f1
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

There is an identifier associated with the software

This test checks if there is a persistent identifier (i.e., Software Heritage ID, Zenodo DOI) associated with the software repository in files like CITATION.cff, codemeta.json and README. This is achieved by looking for an identifier in the files previously mentioned.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/persistent_and_unique_identifier

There is an identifier associated with the software

This test checks if there is a persistent identifier (i.e., Software Heritage ID, Zenodo DOI) associated with the software repository in files like CITATION.cff, codemeta.json and README. This is achieved by looking for an identifier in the files previously mentioned.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.99299d
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/persistent_and_unique_identifier

Repository is from Github/Gitlab

This test checks whether the provided URL points to a repository hosted on a source code repository such as GitHub or GitLab. It verifies both that the URL contains a known domain (e.g., "github.com" or "gitlab.com") and that it is reachable (i.e., the request returns a valid response).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.b93697
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/version_control_use

Repository is from Github/Gitlab

This test checks whether the provided URL points to a repository hosted on a source code repository such as GitHub or GitLab. It verifies both that the URL contains a known domain (e.g., "github.com" or "gitlab.com") and that it is reachable (i.e., the request returns a valid response).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.6fff5e
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/version_control_use

Repository is from Github/Gitlab

This test checks whether the provided URL points to a repository hosted on a source code repository such as GitHub or GitLab. It verifies both that the URL contains a known domain (e.g., "github.com" or "gitlab.com") and that it is reachable (i.e., the request returns a valid response).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.0c61dd
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/version_control_use

Repository is from Github/Gitlab

This test checks whether the provided URL points to a repository hosted on a source code repository such as GitHub or GitLab. It verifies both that the URL contains a known domain (e.g., "github.com" or "gitlab.com") and that it is reachable (i.e., the request returns a valid response).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/version_control_use

Software has releases

This test checks if the software has any releases in the source code repository. This is achieved by checking if there’s any releases created in the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.99299d
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/has_releases

Software has releases

This test checks if the software has any releases in the source code repository. This is achieved by checking if there’s any releases created in the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.656e6c
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/has_releases

Software documentation

This test checks if documentation is found in the repository. This is achieved by looking for a README file, a ReadTheDocs URL in the README file and wikis (in case of GitHub projects).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

Software documentation

This test checks if documentation is found in the repository. This is achieved by looking for a README file, a ReadTheDocs URL in the README file and wikis (in case of GitHub projects).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

Software documentation

This test checks if documentation is found in the repository. This is achieved by looking for a README file, a ReadTheDocs URL in the README file and wikis (in case of GitHub projects).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.a712f1
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

Repository has workflows

This test checks if there are continuous integration workflows in the repository. This is done by looking for a .github.workflows directory in Github and .gitlab-ci.yml file in Gitlab.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/repository_workflows

Dependencies are declared

This test checks if dependencies are declared in the repository. This is achieved by checking if there are dependencies listed in the README file or other files like requirements.txt and pom.xml.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/requirements_specified

Dependencies are declared

This test checks if dependencies are declared in the repository. This is achieved by checking if there are dependencies listed in the README file or other files like requirements.txt and pom.xml.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.cda381
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/requirements_specified

Repository active

This test checks whether the repository is active. It first looks for a repostatus badge with the value “Active” in the README file. If the badge is not present, the test verifies whether there have been any commits to the repository in the recent past, indicating ongoing development.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9ca8a1
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/version_control_use

License is SPDX compliant

This test checks if the repository license is SPDX compliant. This is done by checking if all licenses found in the repository match any of the licenses supported by SPDX.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.95c69f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_has_license

Metadata exists

This test checks if a codemeta.json, CITATION.cff file or package file that includes metadata about a software component exists. This is done by looking for CITATION.cff, codemeta.json and package files (e.g., setup.py, setup.cfg, pom.xml, etc.) in the root of the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/descriptive_metadata

Metadata exists

This test checks if a codemeta.json, CITATION.cff file or package file that includes metadata about a software component exists. This is done by looking for CITATION.cff, codemeta.json and package files (e.g., setup.py, setup.cfg, pom.xml, etc.) in the root of the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/descriptive_metadata

Metadata exists

This test checks if a codemeta.json, CITATION.cff file or package file that includes metadata about a software component exists. This is done by looking for CITATION.cff, codemeta.json and package files (e.g., setup.py, setup.cfg, pom.xml, etc.) in the root of the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.a712f1
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/descriptive_metadata

Contributors are declared

This test checks if there are contributors found in the repository. This is done by looking for contributors in files like CONTRIBUTOR, codemeta.json and package files.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

Contributors are declared

This test checks if there are contributors found in the repository. This is done by looking for contributors in files like CONTRIBUTOR, codemeta.json and package files.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.a712f1
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

Authors have an ORCID

This test checks if authors have an ORCID assigned. This is done by looking for authors in the codemeta.json or AUTHORS files and checking if all of them have an ORCID assigned.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

Authors have an ORCID

This test checks if authors have an ORCID assigned. This is done by looking for authors in the codemeta.json or AUTHORS files and checking if all of them have an ORCID assigned.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.a712f1
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

Presence of tests in repository

This test checks if there are tests present in the repository. This is done by checking if there are files or directories that mention “test” in their names in the root and one level deep in the repository tree.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_has_tests

Software identifier resolves to software

This test checks if the identifier resolves to the software. This is done by looking for an identifier in the README file and trying to resolve it via a request.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/persistent_and_unique_identifier

Software identifier resolves to software

This test checks if the identifier resolves to the software. This is done by looking for an identifier in the README file and trying to resolve it via a request.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9d893d
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/persistent_and_unique_identifier

There is a repostatus badge

This test checks if the repository has a repo status badge in the README file. This is done by checking if the repository has a repostatus badge in the README file.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/version_control_use

There is a repostatus badge

This test checks if the repository has a repo status badge in the README file. This is done by checking if the repository has a repostatus badge in the README file.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/version_control_use

There is a repostatus badge

This test checks if the repository has a repo status badge in the README file. This is done by checking if the repository has a repostatus badge in the README file.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.a712f1
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/version_control_use

Release identifiers follow the same scheme

This test checks if all release identifiers follow the same scheme. This is achieved by checking if there’s any releases created in the repository and that their URLs follow the same pattern or scheme.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.99299d
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/versioning_standards_use

Release identifiers follow the same scheme

This test checks if all release identifiers follow the same scheme. This is achieved by checking if there’s any releases created in the repository and that their URLs follow the same pattern or scheme.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.656e6c
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/versioning_standards_use

Release versions follow a community established convention

This test checks if all version identifiers follow either SemVer or CalVer conventions. This is achieved by checking if there’s any releases created in the repository and that their version numbers (or tags) follow Semantic Versioning (SemVer) or Calendar Versioning (CalVer).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.99299d
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/versioning_standards_use

Release versions follow a community established convention

This test checks if all version identifiers follow either SemVer or CalVer conventions. This is achieved by checking if there’s any releases created in the repository and that their version numbers (or tags) follow Semantic Versioning (SemVer) or Calendar Versioning (CalVer).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.656e6c
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/versioning_standards_use

There is an identifier and resolves

This test checks if there is at least one persistent identifier (i.e., Software Heritage ID, Zenodo DOI) in the README file of the source code repository and if said identifier resolves.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/persistent_and_unique_identifier

There is an identifier and resolves

This test checks if there is at least one persistent identifier (i.e., Software Heritage ID, Zenodo DOI) in the README file of the source code repository and if said identifier resolves.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.99299d
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/persistent_and_unique_identifier

Releases have an id and version number

This test checks if each release has an identifier and version number. This is achieved by checking if there’s any releases created in the repository and that they have a tag and a URL.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.99299d
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/has_releases

Releases have an id and version number

This test checks if each release has an identifier and version number. This is achieved by checking if there’s any releases created in the repository and that they have a tag and a URL.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.656e6c
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/has_releases

Last release consistency

This test checks if the last release tag version number in the source code repository (if there is one) corresponds to the version number stated in the package file of the repository. This is achieved by checking if the version of the last release created in the repository corresponds to the version stated in the package file in the root of the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.99299d
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/has_releases

Last release consistency

This test checks if the last release tag version number in the source code repository (if there is one) corresponds to the version number stated in the package file of the repository. This is achieved by checking if the version of the last release created in the repository corresponds to the version stated in the package file in the root of the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.656e6c
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/has_releases

There are installation instructions

This test checks if the repository has installation instructions. This is achieved by checking in the README file of the repository if there is information about the installation of the software.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

There are installation instructions

This test checks if the repository has installation instructions. This is achieved by checking in the README file of the repository if there is information about the installation of the software.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.cda381
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

Software has license

This test checks whether the software declares a license. It first looks for a LICENSE (or similarly named) file in the root directory of the repository. If not found, it searches for license information in other common locations such as the README file, metadata files like codemeta.json or CITATION.cff, or configuration files such as setup.py.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.95c69f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_has_license

There is a dependencies machine-readable file

This test checks if dependencies are in a machine-readable file (not just in README). This is done by checking if there is a machine-readable file like requirements.txt or pom.xml in the root of the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/requirements_specified

There is a dependencies machine-readable file

This test checks if dependencies are in a machine-readable file (not just in README). This is done by checking if there is a machine-readable file like requirements.txt or pom.xml in the root of the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.cda381
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/requirements_specified

Dependencies have version numbers

This test checks if dependencies have version numbers. This is achieved by checking if all dependencies listed in machine-readable files and in the README file have a version number.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/requirements_specified

Dependencies have version numbers

This test checks if dependencies have version numbers. This is achieved by checking if all dependencies listed in machine-readable files and in the README file have a version number.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.cda381
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/requirements_specified

There is a README

This test checks if there is a README file in the repository. This is done by looking for a README file in the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

There is a README

This test checks if there is a README file in the repository. This is done by looking for a README file in the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

There is a README

This test checks if there is a README file in the repository. This is done by looking for a README file in the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.a712f1
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

There is a codemeta file

This test checks if a codemeta.json file exists in the repository. This is done by looking for a codemeta.json file in the root of the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/descriptive_metadata

There is a codemeta file

This test checks if a codemeta.json file exists in the repository. This is done by looking for a codemeta.json file in the root of the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/descriptive_metadata

There is a codemeta file

This test checks if a codemeta.json file exists in the repository. This is done by looking for a codemeta.json file in the root of the repository.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.a712f1
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/descriptive_metadata

Authors are declared

This test checks if there are authors found in the repository. This is done by looking for authors in files like AUTHORS, codemeta.json and CITATION.cff.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

Authors are declared

This test checks if there are authors found in the repository. This is done by looking for authors in files like AUTHORS, codemeta.json and CITATION.cff.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.a712f1
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_documentation

Metadata record in Software Heritage or Zenodo

This test checks if a metadata record is found on Zenodo and/or Software Heritage. This is done by searching in the README file for a Zenodo or Software Heritage badge.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/archived_in_software_heritage

Metadata record in Software Heritage or Zenodo

This test checks if a metadata record is found on Zenodo and/or Software Heritage. This is done by searching in the README file for a Zenodo or Software Heritage badge.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.aeef8a
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/archived_in_software_heritage

Metadata record in Software Heritage or Zenodo

This test checks if a metadata record is found on Zenodo and/or Software Heritage. This is done by searching in the README file for a Zenodo or Software Heritage badge.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.8367a5
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/archived_in_software_heritage

Software has descriptive metadata

This test checks if descriptive metadata within the repository includes description, programming language, date created and keywords. This is done by looking for those fields in codemeta.json, README, CITATION.cff or any package metadata file ( (e.g., setup.py, setup.cfg, pom.xml, etc.).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/descriptive_metadata

Software has descriptive metadata

This test checks if descriptive metadata within the repository includes description, programming language, date created and keywords. This is done by looking for those fields in codemeta.json, README, CITATION.cff or any package metadata file ( (e.g., setup.py, setup.cfg, pom.xml, etc.).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/descriptive_metadata

Software has descriptive metadata

This test checks if descriptive metadata within the repository includes description, programming language, date created and keywords. This is done by looking for those fields in codemeta.json, README, CITATION.cff or any package metadata file ( (e.g., setup.py, setup.cfg, pom.xml, etc.).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.a712f1
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/descriptive_metadata

There are title and description

This test checks if the repository has title and description of the software available within any metadata file. This is achieved by checking if description and title are in the README file, codemeta.json file or any other package file (e.g., setup.py, setup.cfg, pom.xml, etc.).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/descriptive_metadata

There are title and description

This test checks if the repository has title and description of the software available within any metadata file. This is achieved by checking if description and title are in the README file, codemeta.json file or any other package file (e.g., setup.py, setup.cfg, pom.xml, etc.).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.60a40f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/descriptive_metadata

There are title and description

This test checks if the repository has title and description of the software available within any metadata file. This is achieved by checking if description and title are in the README file, codemeta.json file or any other package file (e.g., setup.py, setup.cfg, pom.xml, etc.).

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.a712f1
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/descriptive_metadata

There is an article citation or reference publication

This test checks if there is a referencePublication or a citation file to a paper. This is done by looking for an article citation in the README file, for a CITATION.cff file or a referencePublication field in the codemeta.json file.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.6d7a69
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_has_citation

Repository has citation

This test checks if there is a CITATION.cff file or citations made in the README file. This is done by looking in the root of the repository for a CITATION.cff file and by checking if the README file contains citations.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.6d7a69
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_has_citation

There are actions to automate tests

This test checks if there are actions or workflows that automate tests. This is done by checking if there are workflows that mention “test” in their names in .github.workflows directory for Github and .gitlab-ci.yml file for Gitlab.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.9bf822
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_has_tests

License referenced in metadata files

This test checks if metadata files like codemeta.json, CITATION.cff or package file contain a link to the repository license. This is done by looking if a license field is within said files.

API Definition

Additional Details
Dimension https://doi.org/10.25504/FAIRsharing.95c69f
Domain
Benchmark or Metric https://w3id.org/everse/i/indicators/software_has_license

FAIR Test - License

FAIR Test - License description

API Definition

Additional Details
Dimension
Domain http://purl.obolibrary.org/obo/NCIT_C17039
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.DfMGZW

FAIR Test - ARK T-F1 - Persistent Identifiers for Database Content

The 'FAIR Test ARK T-F1 - Persistent Identifiers for Database Content' is a database-level test that requires the minting of persistent identifiers for at least some of the content within the database being evaluated. It expects a FAIRsharing URL or DOI as its input and evaluates that FAIRsharing record for the presence of an implemented id schema. An important facet of FAIR for databases is that they mint persistent identifiers. As described by the GFF, global uniqueness guarantees the unambiguous referencing of the described resource; it is insufficient for it to be unique only locally. Persistence refers to the requirement that this globally unique identifier is never reused elsewhere and continues to identify the same resource over time. These features are key to the Findability of the database being evaluated. The test will return as follows: Pass: GUID must point to an existing FAIRsharing database record; the record must have an 'implements' to an id_schema record. Indeterminate: GUID is non-existent or malformed. Fail: if any of the conditions in 'pass' fail; specifically, if the GUID is not a database record, OR if there is no 'implements' relationship to an id_schema.

API Definition

Additional Details
Dimension
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://tools.ostrails.eu/fdp-index-proxy/proxy?url=https://ostrails.github.io/assessment-component-metadata-records/test/FTARKTF1.ttl

FAIR Test - ARK T-F1 - Persistent Identifiers for Database Content

The 'FAIR Test ARK T-F1 - Persistent Identifiers for Database Content' is a database-level test that requires the minting of persistent identifiers for at least some of the content within the database being evaluated. It expects a FAIRsharing URL or DOI as its input and evaluates that FAIRsharing record for the presence of an implemented id schema. An important facet of FAIR for databases is that they mint persistent identifiers. As described by the GFF, global uniqueness guarantees the unambiguous referencing of the described resource; it is insufficient for it to be unique only locally. Persistence refers to the requirement that this globally unique identifier is never reused elsewhere and continues to identify the same resource over time. These features are key to the Findability of the database being evaluated. The test will return as follows: Pass: GUID must point to an existing FAIRsharing database record; the record must have an 'implements' to an id_schema record. Indeterminate: GUID is non-existent or malformed. Fail: if any of the conditions in 'pass' fail; specifically, if the GUID is not a database record, OR if there is no 'implements' relationship to an id_schema.

API Definition

Additional Details
Dimension
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://ostrails.github.io/assessment-component-metadata-records/test/FTARKTF1.ttl

FAIR Test - ARK T-F1 - Persistent Identifiers for Database Content

The 'FAIR Test ARK T-F1 - Persistent Identifiers for Database Content' is a database-level test that requires the minting of persistent identifiers for at least some of the content within the database being evaluated. It expects a FAIRsharing URL or DOI as its input and evaluates that FAIRsharing record for the presence of an implemented id schema. An important facet of FAIR for databases is that they mint persistent identifiers. As described by the GFF, global uniqueness guarantees the unambiguous referencing of the described resource; it is insufficient for it to be unique only locally. Persistence refers to the requirement that this globally unique identifier is never reused elsewhere and continues to identify the same resource over time. These features are key to the Findability of the database being evaluated. The test will return as follows: Pass: GUID must point to an existing FAIRsharing database record; the record must have an 'implements' to an id_schema record. Indeterminate: GUID is non-existent or malformed. Fail: if any of the conditions in 'pass' fail; specifically, if the GUID is not a database record, OR if there is no 'implements' relationship to an id_schema.

API Definition

Additional Details
Dimension
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://tools.ostrails.eu/fdp-index-proxy/proxy?url=https://ostrails.github.io/assessment-component-metadata-records/test/FTARKTF1.ttl

FAIR Test - ARK T-F1 - Persistent Identifiers for Database Content

The 'FAIR Test ARK T-F1 - Persistent Identifiers for Database Content' is a database-level test that requires the minting of persistent identifiers for at least some of the content within the database being evaluated. It expects a FAIRsharing URL or DOI as its input and evaluates that FAIRsharing record for the presence of an implemented id schema. An important facet of FAIR for databases is that they mint persistent identifiers. As described by the GFF, global uniqueness guarantees the unambiguous referencing of the described resource; it is insufficient for it to be unique only locally. Persistence refers to the requirement that this globally unique identifier is never reused elsewhere and continues to identify the same resource over time. These features are key to the Findability of the database being evaluated. The test will return as follows: Pass: GUID must point to an existing FAIRsharing database record; the record must have an 'implements' to an id_schema record. Indeterminate: GUID is non-existent or malformed. Fail: if any of the conditions in 'pass' fail; specifically, if the GUID is not a database record, OR if there is no 'implements' relationship to an id_schema.

API Definition

Additional Details
Dimension
Domain http://www.fairsharing.org/ontology/subject/SRAO_0000401
Benchmark or Metric https://ostrails.github.io/assessment-component-metadata-records/test/FTARKTF1.ttl

FAIR TestX - License

FAIR Test - License description, new test performed again

API Definition

Additional Details
Dimension
Domain http://purl.obolibrary.org/obo/NCIT_C17039
Benchmark or Metric https://doi.org/10.25504/FAIRsharing.DfMGZW