-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8bf04ee
commit 75188d6
Showing
18 changed files
with
16,758 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <title>About the </title> | ||
| <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous"> | ||
| <style> | ||
| body { | ||
| margin: 2em; | ||
| } | ||
|
|
||
| .tooltip-inner { | ||
| max-width: 280px; | ||
| } | ||
|
|
||
| .check { | ||
| text-align: center; | ||
| } | ||
|
|
||
| .fixedHeader { | ||
| position: sticky; | ||
| top: 0; | ||
| background-color: white; | ||
| } | ||
|
|
||
| th { | ||
| max-width: 4em; | ||
| height: 5em; | ||
| } | ||
|
|
||
| th a { | ||
| display: block; | ||
| transform: rotate(-45deg); | ||
| margin: 0.2em; | ||
| } | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <h1>OBO Dashboard</h1> | ||
| <p><strong>The OBO Dashboard is a new feature under active development.</strong></p> | ||
| <p>The OBO Dashboard is being developed by the OBO Operations Committee and members of the Technical Working Group. Our goal is to provide a set of automated tests that establish a minimum level of compliance with OBO Principles and best practises. Keep in mind that automated checks often cannot capture the full intent of a given principle – we do our best while keeping the automated checks as fast and cheap as possible.</p> | ||
| <p>For each ontology, two aspects are checked: the OBO Registry entry, and the latest release of the project’s main OWL file. For each check we provide links to the rule text and implementation.</p> | ||
| <p><strong>Please give us your feedback!</strong></p> | ||
| <p><a href="https://github.com/OBOFoundry/OBOFoundry.github.io/issues/1076">This issue</a> is for general comments, with links to the specific issue for each check.</p> | ||
| <hr> | ||
| <h2>Limitations</h2> | ||
| <p>This is an alpha version of an automated representation of the OBO Foundry principles. Many of the principles contain a subjective aspect, making the checks difficult to implement. These checks are still in review and subject to change.</p> | ||
| <p><strong>The result of the OBO Foundry Dashboard is not a reflection of the quality of content of an ontology.</strong> </p> | ||
| <p>It is simply a means to alert ontology developers to areas that may need review.</p> | ||
| <hr> | ||
| <h2>Reading the Dashboard</h2> | ||
| <p>The dashboard page contains a table with all results from all OBO Foundry ontologies. These results are sorted in the same order that the ontologies appear on the OBO Foundry homepage: foundry ontologies, active ontologies, orphaned, and finally obsolete ontologies.</p> | ||
| <p>Each column after the ontology ID represents one dashboard check. There are four levels of results for each column:</p> | ||
| <ol> | ||
| <li>Pass - green check</li> | ||
| <li>Info - blue <em>i</em></li> | ||
| <li>Warning - yellow exclamation point</li> | ||
| <li>Error - red <strong>x</strong></li> | ||
| </ol> | ||
| <p>For details on what constitutes a pass versus an error for each check, click on the column header.</p> | ||
| <p>The last column contains a summary of the dashboard check. This column corresponds to the lowest result of all checks. For example, if there are any errors, this column will contain a red <strong>x</strong>. Likewise, if there are any infos, but no errors or warnings, this column will contain a blue <em>i</em>.</p> | ||
| <p>Finally, you can download the report summary as a YAML file from the link near the top of the page.</p> | ||
| <hr> | ||
| <h2>Reading Individual Results</h2> | ||
| <p>To view more details on an ontology’s results, click on the ontology ID in the first column.</p> | ||
| <p>From the dashboard report page, you can see the version IRI that the dashboard was run on (for all OWL file checks) and the date it was run. Some checks include reports, which you can view under the <strong>Resources</strong> column. Each individual report page includes a link to download those reports as TSV files.</p> | ||
| <h4>Reading ROBOT Reports</h4> | ||
| <p><a href="http://robot.obolibrary.org/report">ROBOT report</a> runs a series of standard queries over the OWL file. More details on these queries can be <a href="http://robot.obolibrary.org/report_queries/">found here</a>. Like the dashboard checks, report has three levels of violations (passing results are not shown in the table): info, warning, and error.</p> | ||
| <p>Each row contains the violation level, the rule name (corresponding to a query), the subject of the violation, the property of the violation, and the value of the violation. For specific details on what the rule checks and how to fix it, click on the rule name.</p> | ||
| <hr> | ||
| <hr/> | ||
| </body> | ||
| </html> |
Oops, something went wrong.