Responsiveness Automated Check

• Overview
• Open (principle 1)
• Common Format (principle 2)
• URI/Identifier Space (principle 3)
• Versioning (principle 4)
• Scope (principle 5)
• Textual Definitions (principle 6)
• Relations (principle 7)
• Documentation (principle 8)
• Documented Plurality of Users (principle 9)
• Commitment To Collaboration (principle 10)
• Locus of Authority (principle 11)
• Naming Conventions (principle 12)
• Notification of Changes (principle 13)
• Maintenance (principle 16)
• Responsiveness (principle 20)

Responsiveness Automated Check

Discussion on this check can be found here.

Requirements

1. The ontology must have a tracker.

Fixes

First, read the FAQ on how to edit the metadata for your ontology.

Adding a Tracker

If you do not already have a version control repository that has an Issues Tracker, create one. We recommend creating a GitHub Repository. To do this, you will need to create a GitHub account if you do not already have one.

Once you have a version control repository, add the following to your metadata file (replacing with the link to your repository’s issue tracker):

tracker: https://github.com/DiseaseOntology/HumanDiseaseOntology/issues

Implementation

The registry data is checked for ‘tracker’ entry. If it is missing, this is an error.

import dash_utils
from dash_utils import format_msg


def is_responsive(data):
    """Check fp 20 - responsiveness.
    If the ontology has an active issue tracker, PASS.

    Args:
        data (dict): ontology registry data from YAML file

    Return:
        PASS or ERROR with optional help message
    """
    if 'tracker' in data:
        tracker = data['tracker']
    else:
        tracker = None

    if tracker is None:
        return {'status': 'ERROR', 'comment': 'Missing tracker'}

    return {'status': 'PASS'}