Skip to content

How to add your own OBO Dashboard badge #78

@matentzn

Description

@matentzn

We have recently developed a few badges for our ontology projects. Here is an example of how these can be used in practice in a README.md.

  • A badge that indicates that you are using ODK: Powered by the ODK
  • A badge that indicates that you are using ROBOT: Powered by the ROBOT
  • The OBO Dashboard QC badge which tells you if your ontology has problems according to the OBO Dashboard:
  • The OBO Dashboard score badge which gives an indication how good your ontologies does on the OBO Dashboard:

You can add these badges as follows. The first two badges can simply copy pasted into the README.md:

ODK:

[![Powered by the ODK](https://img.shields.io/static/v1?label=Powered%20by&message=ODK&color=blue&style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAC0AAAAtCAYAAAA6GuKaAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAE/AAABPwBw3rtuAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAWKSURBVFiF7ZlrbBRVFMf/ty9QKC2lQIMCQo0glEDiA/BRNIGgBSURRIJoDAFMkGCIjyCp+IogMfEDTy2v1Ac+aA2+GgohRhBIG6wlImAiKijwQWhLpaGUuj8/zG64XGans+2CMfEkm8zO+Z9zfjNz995zZ6X/7aIB9wKHgSPAd8BWIPPf5go0YCOX27hk5E5pJ1BgHJAhaZKP66721HMtIWggA3hJ0hHg9gDpOEndfc7fnUi9DhswGKi1HnUT8FAcbanP0IjFpF8t4DTgtA/E38Azjm4k0BAHGmD0VYGOAn0dAFIKvA80BmhidhaYfbWgnw0B1JYdA5LyYwwLPbgtopaWFtasXs3G9Rv83MeB65PBkhZWaIw5DByRlC9JDfX1WleyVlnZ2Zo1Z7bKNm/WyRMndPp0nYhEBKi8rEyTp0yRMUaSZhpj/kgGdKLzdGXs4NPychVNnKD09HRVV1Vrf22txt93vyQJ0Np3SpSXlxcDrjbGVNqJgMeBb4CvgLFXBBoYKGlq7Pu5c83Kzc1VVlaWGhrq1bdvP/W/ob8kKUJE39fUqGDYsJj8cyfXNEmlkgolFUmqTGSsh4IGOkvaIik3di7/xnxt3LBB2yorNbSgQNVVVVq5fIVSUoxSU1L12pLXtWzpGwIk6YiT0p09UiTNCAttHLiJkuZJapB0RlJ99HiEpEfc4GNHj6prZqZycnLU1NSk1tZWASKCuud0V31dvbp1y1RqWto0Y8zHVp3tktwhscIYM9/hyTLGnAm8AmBvx2a0uLbYqfOg428GRjiaIcB54EWXM80SDZU0KvCqErNfo58MSXc4vgJJmyRdI+mcpFXGmFpHM0jSn5IOxq0AvJyEO9oKrAFuCqgzBtgGpPr4coDhQB6wD+gZeFuARR0ErgMK26jRG29DkOfjexpvmABcAOYGAluBDxOuf3CtGbjNJ19eDBBIwdu93OOjG4zXfNnmDpdA8EHADwlCFzs5pgI/Wf5DwEfAojg1p8fJm5EIeBdgc0jgRqCLFftUgHaupcvEe7KbuLRPj9kFYAZeu9sZuDYM+BMhocusmF54jX48OwvMA74EdgPFQEE09i1LdwaYAiwBaoCT0bwj24JeGBK62IoJc6GlQL84NYcARUCOda7Iin1OCu7ywm6LGq3jPiH0B40xx/wcxpiDunxe3iGpRFIPef2KPzTQVVLwo7hoPazj30LoE+osjTHnJT0ZmADv3cQBSRNC5r3VOv5CUl2A9pSkfKAKb17OidbMBlbiLSjrgOtCVY4GrgciIcdyzM4Dvaw8k4AWH10LMCGqyQTmALuA94AdjvYQbe3agf5426H22ion30igAm/ROYu3qNQAA3xqj42T8862oHNJ/A7bFsHnHQiwk+gdA0YDFXGesF/tWwKho8GHOwAN3uOf5eTc63xfDjzmU/sTJ9dewLg6P+jlHYQG74eUHwCdidcw9XTOdwKeB8qBpYDfKzVf6FHAdp/PLyGBS7DaTcAAu33qTAeO4i3TB4AxoQATMeBm/GcD27biPE68seo3hrc7sY3unU8W+JsBwK14O3U3ZiywxTnXJU6OyVcCuhPwY5yC2xxtFvCt5d9DdIzi9dT1Pjk+AAYlGzqN+PP4K4622EezxPLPd3wVwAPAFqAaeDdZ0O7u2bYFjvZDH02FoykEfgcexVr5gPHAwmRBfxYA/aqj9dtrLnM0XXGGVVIN6IM3PcWzHT5AOy3/HiDb8htgMbAfq29ONvQLAcC78ZqsgU5MCl5Dvw+vzbV9hVb80vYwhXnVe0pSRJe2sRFJyyQtNsa0ugHGmIikg8AuScMl2YvMcUnNkjpL+rk90KEMmAz8Fb07Jwn5ahZYAKzxOT+A4H/HkmN47ybeBnonEDMT2HQluf4z9g9zJvC1+liz2QAAAABJRU5ErkJggg==)](https://github.com/INCATools/ontology-development-kit)

ROBOT:

[![Powered by the ROBOT](https://img.shields.io/static/v1?label=Powered%20by&message=ROBOT&color=green&style=flat)](http://robot.obolibrary.org/)

The other two can be copied in, but the string ONTOLOGYID needs to be replaced by your lower case ontology id, i.e cl, uberon, mp, obi, etc.

QC Badge:

<a href="http://dashboard.obofoundry.org/dashboard/ONTOLOGYID/dashboard.html"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2FOBOFoundry%2Fobo-dash.github.io%2Fgh-pages%2Fdashboard%2FONTOLOGYID%2Fdashboard-qc-badge.json" /></a>

OBO Dashboard Score Badge:

<a href="http://dashboard.obofoundry.org/dashboard/ONTOLOGYID/dashboard.html"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2FOBOFoundry%2Fobo-dash.github.io%2Fgh-pages%2Fdashboard%2FONTOLOGYID%2Fdashboard-score-badge.json" /></a>

At OBO Operations level, we will want to decide whether to include any of these in the obofoundry.org overview table. Feel free to add your comments here about thoughts on that.

You can see your Dashboard score in this page, in the table with the column score_dash.

http://dashboard.obofoundry.org/dashboard/analysis.html#:~:text=OBO%20Score%20(Experimental)

This issue is just about the badges. For comments on the score see #64

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions