Skip to content

Commit

Permalink
Merge branch 'master' into matentzn-patch-17
Browse files Browse the repository at this point in the history
  • Loading branch information
matentzn authored Oct 6, 2024
2 parents c0ea899 + 903f091 commit 28f488d
Show file tree
Hide file tree
Showing 18 changed files with 1,472 additions and 1,152 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/new-ontology.yml
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ body:
attributes:
label: Ontology Download Link
description: What URL can be used to download your Ontology?
placeholder: e.g. https://github.com/obophenotype/uberon/raw/master/uberon.owl
placeholder: e.g. https://github.com/obophenotype/uberon/blob/master/uberon.obo
validations:
required: true

Expand Down Expand Up @@ -208,7 +208,7 @@ body:
render: yaml
description: |
Please provide a list of current uses for your ontology in YAML format as a list of objects with `user`, `description`, and `example` keys like in the following example:
```yaml
- user: https://www.rhea-db.org/
description: Rhea uses CHEBI to annotate reaction participants
Expand All @@ -228,7 +228,7 @@ body:
attributes:
value: |
# Finishing Up
This final section asks you to introspect on your ontology request.
- type: textarea
id: scenarios
Expand Down Expand Up @@ -266,7 +266,7 @@ body:
required: false
- label: My identifiers (classes and properties IRIs) are formatted according to the [OBO Foundry Identifier Policy](http://obofoundry.org/id-policy)
required: false
- label: My term labels are in English and conform to the OBO Foundry [Naming Conventions](http://obofoundry.org/http://obofoundry.org/principles/fp-012-naming-conventions.html)
- label: My term labels are in English and conform to the OBO Foundry [Naming Conventions](http://obofoundry.org/principles/fp-012-naming-conventions.html)
required: false
- label: I understand that term definitions are key to understanding the intentions of a term, especially when the ontology is used in curation. I made sure that a reasonable majority of terms in my ontology--and all top level terms--have definitions, in English, using the [IAO:0000115](https://ontobee.org/ontology/IAO?iri=http://purl.obolibrary.org/obo/IAO_0000115) property.
required: false
Expand Down
59 changes: 56 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2334,9 +2334,9 @@ ontologies:
id: foodon
layout: ontology_detail
license:
label: CC BY 3.0
label: CC BY 4.0
logo: http://mirrors.creativecommons.org/presskit/buttons/80x15/png/by.png
url: http://creativecommons.org/licenses/by/3.0/
url: http://creativecommons.org/licenses/by/4.0/
ontology_purl: http://purl.obolibrary.org/obo/foodon.owl
preferredPrefix: FOODON
products:
Expand All @@ -2357,6 +2357,27 @@ ontologies:
- food
title: Food Ontology
tracker: https://github.com/FoodOntology/foodon/issues/
usages:
- description: FoodData Central nutrition database web portal provided by USDA Agricultural
Research Service.
examples:
- description: An entry for 'Apples, fuji, with skin, raw' from the FoodData Central
nutrition database which is annotated with the term FOODON:00002862.
url: https://fdc.nal.usda.gov/fdc-app.html#/food-details/1750340/attributes
user: https://fdc.nal.usda.gov/
- description: FDA GenomeTrackr surveillance program for reporting foodborne pathogen
biosamples.
examples:
- description: An entry from NCBI Biosample that describes a *Samonella enterica*
sample extracted from Chicken and annotated with the term FOODON:03411457.
url: https://www.ncbi.nlm.nih.gov/biosample/SAMN03455272
user: https://www.fda.gov/food/whole-genome-sequencing-wgs-program/genometrakr-network
- description: Wiki database consolidating over 30 global food composition databases.
examples:
- description: An entry from WikiFCD that describes Walnuts and is annotated with
the term FOODON:03301364.
url: https://wikifcd.wikibase.cloud/wiki/Item:Q568877
user: https://wikifcd.wikibase.cloud/wiki/Main_Page
- activity_status: active
contact:
email: [email protected]
Expand Down Expand Up @@ -3881,7 +3902,7 @@ ontologies:
title: Monarch Phenotype Page
url: http://monarchinitiative.org/phenotype/MP:0000001
contact:
email: [email protected]
email: [email protected]
github: sbello
label: Sue Bello
orcid: 0000-0003-4606-0597
Expand Down Expand Up @@ -6287,11 +6308,43 @@ ontologies:
products:
- id: stato.owl
ontology_purl: http://purl.obolibrary.org/obo/stato.owl
publications:
- id: https://www.ncbi.nlm.nih.gov/pubmed/31831744
title: Experiment design driven FAIRification of omics data matrices, an exemplar
- id: https://www.ncbi.nlm.nih.gov/pubmed/32109232
title: Semantic concept schema of the linear mixed model of experimental observations
repository: https://github.com/ISA-tools/stato
tags:
- statistics
title: The Statistical Methods Ontology
tracker: https://github.com/ISA-tools/stato/issues
usages:
- description: struct (Statistics in R using Class-based Templates), Struct integrates
with the STATistics Ontology to ensure consistent reporting and maximizes semantic
interoperability
publications:
- id: https://www.ncbi.nlm.nih.gov/pubmed/33325493
title: 'struct: an R/Bioconductor-based framework for standardized metabolomics
data analysis and beyond'
type: annotation
user: https://bioconductor.org/packages/release/bioc/html/struct.html
- description: Scientific Evidence Code System (SEVCO) on the FEvIR platform. The
FEvIR Platform includes many Builder Tools to create FHIR Resources without
requiring expertise in FHIR or JSON, and Converter Tools to convert structured
data to FHIR Resources
publications:
- id: https://www.ncbi.nlm.nih.gov/pubmed/33486066
title: 'Making science computable: Developing code systems for statistics, study
design, and risk of bias'
type: annotation
user: https://fevir.net/resources/CodeSystem/27270#STATO:0000039
- description: OBCS
publications:
- id: https://www.ncbi.nlm.nih.gov/pubmed/27627881
title: The Ontology of Biological and Clinical Statistics (OBCS) for standardized
and reproducible statistical analysis
type: annotation
user: https://github.com/obcs/obcs
- activity_status: active
contact:
email: [email protected]
Expand Down
11 changes: 11 additions & 0 deletions _includes/citation_toc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[OBO Citation and Attribution Policy](/citation/Citation.html)

- [Referring to a single term](/citation/Citation.html#single-term)
- [Referring to an ontology](/citation/Citation.html#refer-ontology)
- [Citing an ontology](/citation/Citation.html#cite-ontology)

[OBO Foundry Publications](/citation/RelatedPublications.html)
- [Citing the OBO Foundry](/citation/RelatedPublications.html#citing)
- [Other OBO Foundry Publications](/citation/RelatedPublications.html#other)

[OBO Foundry Ontology Publications](/citation/KnownPublications.html)
14 changes: 3 additions & 11 deletions _includes/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,9 @@
Citation
</a>
<ul class="dropdown-menu" aria-labelledby="navbarCitationDropdown">
<li><a class="dropdown-item" href="/docs/Citation.html">Cite Ontologies</a></li>
<li><a class="dropdown-item" href="/registry/publications.html">Cite the OBO Foundry</a></li>
<li><a class="dropdown-item" href="/registry/publications.html">Publications Related to the OBO
Foundry</a></li>
<li><a class="dropdown-item" href="/citation/Citation.html">Cite Ontologies</a></li>
<li><a class="dropdown-item" href="/citation/RelatedPublications.html">OBO Foundry Publications</a></li>
<li><a class="dropdown-item" href="/citation/KnownPublications.html">Known OBO Foundry Ontology Publications</a></li>
</ul>
</li>

Expand Down Expand Up @@ -169,13 +168,6 @@
<a class="nav-link" href="/faq/index.html">FAQ</a>
</li>
</ul>
<form class="d-flex" role="search" action="https://ontobee.org/search" method="get">
<!-- while the ontology input doesn't do anything, the Ontobee site is broken and doesn't work if it's missing -->
<input name="ontology" type="hidden" value=""/>
<input class="form-control me-2" type="search" placeholder="Search Ontobee" aria-label="Search"
name="keywords">
<button class="btn btn-outline-success" type="submit">Search</button>
</form>
</div>
</div>
</nav>
52 changes: 52 additions & 0 deletions _layouts/citation.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
layout: default
---
<div class="content">
<div>
<div class="page-header">
<h1>{{ page.title }}</h1>
</div>
</div>

<div class="col-md-12">
<div class="row">
<div class="col-md-3">
{% capture my_include %}{% include citation_toc.md %}{% endcapture %} {{
my_include | markdownify }} {% if page.id %}
<div class="btn-group" role="group" aria-label="Source">
<a
href="https://github.com/OBOFoundry/OBOFoundry.github.io/blob/master/citation/{{page.id}}.md"
>
<button
type="button"
data-toggle="tooltip"
title="See FAQ entry: How is metadata stored?"
html="true"
class="btn btn-outline-primary"
>
View
</button>
</a>
<a
href="https://github.com/OBOFoundry/OBOFoundry.github.io/edit/master/citation/{{page.id}}.md"
>
<button
type="button"
data-toggle="tooltip"
title="See FAQ entry: How I do edit my metadata?"
html="true"
class="btn btn-outline-primary"
>
Edit
</button>
</a>
<!-- <button type="button" class="btn btn-outline-primary">Help</button> -->
</div>
{% endif %}
</div>

<div class="col-md-9">{{ content }}</div>
</div>
</div>
</div>

4 changes: 2 additions & 2 deletions _layouts/ontology_detail.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ <h1>
</div>
</div>

{% if page.publications %}
<div class="card" style="margin-bottom: 1.5em;">
{% if page.publications and page.publications.size > 0 %}
<div class="card" style="margin-bottom: 1.5em;" id="publications">
<div class="card-header">
Publications
</div>
Expand Down
9 changes: 9 additions & 0 deletions assets/css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,12 @@ Slightly darken failing ontologies
.dash-status {
margin-bottom: 3px;
}

/*
Custom blockquote formatting
*/
.citation-blockquote {
padding: 5px;
margin-left: 20px;
margin-bottom: 16px;
}
37 changes: 25 additions & 12 deletions docs/Citation.md → citation/Citation.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,59 @@
---
layout: doc
layout: citation
title: OBO Citation and Attribution Policy
---

Open Biological and Biomedical Ontologies are used in a diversity of ways. The following guidelines are intended to promote proper attribution of the ontology creators and contributors, and to promote reproducibility in informatics applications.
Open Biological and Biomedical Ontologies are used in a variety of ways. The following guidelines are intended to promote proper attribution of the ontology creators and contributors, and to promote reproducibility in informatics applications.

## Referring to a single term
<h2 id="single-term">Referring to a single term</h2>

When referring to a single ontology term, use the full [Internationalized Resource Identifier (IRI)](http://tools.ietf.org/html/rfc3987), for example:

> http://purl.obolibrary.org/obo/UBERON_0000948
<div class="citation-blockquote">
http://purl.obolibrary.org/obo/UBERON_0000948
</div>

You can use a shorter [Compact URI (CURIE)](https://www.w3.org/TR/curie/) by defining a prefix that abbreviates the first part of the IRI. For example, the prefix "UBERON" can abbreviate "http://purl.obolibrary.org/obo/UBERON_", then "http://purl.obolibrary.org/obo/UBERON_0000948" can be shortened to "[UBERON:0000948](http://purl.obolibrary.org/obo/UBERON_0000948)". A footnote like this one should be included with the first use of the prefix:

> [UBERON:0000948](http://purl.obolibrary.org/obo/UBERON_0000948) is a Compact URI (CURIE). Here and subsequently the prefix "UBERON" expands to "http://purl.obolibrary.org/obo/UBERON_". The full identifier for the term is then <http://purl.obolibrary.org/obo/UBERON_0000948>. Browsing to this address gives further information about the term.
<div class="citation-blockquote">
<a href="http://purl.obolibrary.org/obo/UBERON_0000948">UBERON:0000948</a> is a Compact URI (CURIE). Here and subsequently the prefix "UBERON" expands to "http://purl.obolibrary.org/obo/UBERON_". The full identifier for the term is then <a href="http://purl.obolibrary.org/obo/UBERON_0000948">http://purl.obolibrary.org/obo/UBERON_0000948</a>. Browsing to this address gives further information about the term.
</div>

In situations that allow the use of hyperlinks, every CURIE should be a hyperlink with its full IRI as its target, as in these examples.

We also recommend including the primary label of the term in quotation marks before the IRI or CURIE:

> 'heart' ([UBERON:0000948](http://purl.obolibrary.org/obo/UBERON_0000948))
<div class="citation-blockquote">
'heart' (<a href="http://purl.obolibrary.org/obo/UBERON_0000948">UBERON:0000948</a>)
</div>

## Referring to an ontology
<h2 id="refer-ontology">Referring to an ontology</h2>

To facilitate reproducibility, be specific about the version of the ontology that you are referring to by using an ontology version IRI that contains the release date:

> http://purl.obolibrary.org/obo/uberon/releases/2016-01-26/uberon.owl
<div class="citation-blockquote">
http://purl.obolibrary.org/obo/uberon/releases/2016-01-26/uberon.owl
</div>

The ontology version IRI is indicated by the [owl:versionIRI](https://www.w3.org/2002/07/owl#versionIRI) property.

When referring to an ontology in general (not a specific version) you can use its ontology IRI:

> http://purl.obolibrary.org/obo/uberon.owl
<div class="citation-blockquote">
http://purl.obolibrary.org/obo/uberon.owl
</div>

The ontology IRI or ontology version IRI should be accompanied by a citation of the ontology, in any context where citations are appropriate.

## Citing an ontology
<h2 id="cite-ontology">Citing an ontology</h2>

Some ontologies recommend citation of specific publications. Please see their respective homepages for this information. For example, [Uberon](http://obofoundry.org/ontology/uberon) lists two publications under "Cite."
Some ontologies recommend citation of specific publications. Please see their respective homepages for this information. For example, [Uberon]({{ "ontology/uberon.html#publications" | prepend: site.baseurl }}) lists two publications under "Publications."

In addition to the recommended publication, you should also cite the ontology using its IRI and the [new data citation extension to JATS](https://peerj.com/articles/cs-1/). When no specific publication is recommended, you must cite the ontology by its IRI. Here is an example citation:

> Mungall, C., Haendel, M., Dahdul, W., Ibrahim, N., Segerdell, E., Blackburn, D., Comte, A., Niknejad, A., and Decechi, A. (2016), Uberon Ontology, http://purl.obolibrary.org/obo/uberon/releases/2016-01-26/uberon.owl
<div class="citation-blockquote">
Mungall, C., Haendel, M., Dahdul, W., Ibrahim, N., Segerdell, E., Blackburn, D., Comte, A., Niknejad, A., and Decechi, A. (2016), Uberon Ontology, http://purl.obolibrary.org/obo/uberon/releases/2016-01-26/uberon.owl
</div>

Our ontology files list authors using the [dc:creator](http://purl.org/dc/elements/1.1/creator) property. The order of authors is not important, but you can use the primary contact for the ontology listed on the [OBO site](http://obofoundry.org) as the first author. Note that this does not necessarily include all those who have contributed directly to the ontology, via its issue tracker or on its mailing lists, for example. However, these can be readily retrieved if the proper IRI is referenced in the citation.

18 changes: 18 additions & 0 deletions citation/KnownPublications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: citation
title: Known Ontology Project Publications
---

This list is generated automatically from OBO Foundry ontology metadata. It is not intended to be authoritative or exhaustive.
<div>
{% for ontology in site.ontologies %}
{% if ontology.publications and ontology.publications.size > 0 %}
<h5>{{ ontology.title }} ({{ ontology.id }})</h5>
<ul>
{% for publication in ontology.publications %}
<li><a href="{{ publication.id }}" target="_blank" rel="noopener">{{ publication.title }}</a></li>
{% endfor %}
</ul>
{% endif %}
{% endfor %}
</div>
15 changes: 15 additions & 0 deletions citation/RelatedPublications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
layout: citation
title: Publications Related to the OBO Foundry
---
<h2 id="citing">Citing the OBO Foundry</h2>

To reference the OBO Foundry generally, please cite:

Rebecca Jackson, Nicolas Matentzoglu, James A Overton, Randi Vita, James P Balhoff, Pier Luigi Buttigieg, Seth Carbon, Melanie Courtot, Alexander D Diehl, Damion M Dooley, William D Duncan, Nomi L Harris, Melissa A Haendel, Suzanna E Lewis, Darren A Natale, David Osumi-Sutherland, Alan Ruttenberg, Lynn M Schriml, Barry Smith, Christian J Stoeckert Jr., Nicole A Vasilevsky, Ramona L Walls, Jie Zheng, Christopher J Mungall, Bjoern Peters, **[OBO Foundry in 2021: operationalizing open data principles to evaluate ontologies](https://academic.oup.com/database/article/doi/10.1093/database/baab069/6410158)**, Database, Volume 2021, 2021, baab069, https://doi.org/10.1093/database/baab069

<h2 id="other">Other papers about the OBO Foundry</h2>

Barry Smith, Michael Ashburner, Cornelius Rosse, Jonathan Bard, William Bug, Werner Ceusters, Louis J Goldberg, Karen Eilbeck, Amelia Ireland, Christopher J Mungall, The OBI Consortium, Neocles Leontis, Philippe Rocca-Serra, Alan Ruttenberg, Susanna-Assunta Sansone, Richard H Scheuermann, Nigam Shah, Patricia L Whetzel, and Suzanna Lewis, **[The OBO Foundry: coordinated evolution of ontologies to support biomedical data integration](http://www.nature.com/nbt/journal/v25/n11/abs/nbt1346.html)**, Nature Biotechnology, Volume 25, 2007, https://doi.org/10.1038/nbt1346

[Google Scholar list of papers citing The OBO Foundry](https://scholar.google.ca/scholar?cites=13806088078865650870&as_sdt=2005&sciodt=0,5&hl=en)
Loading

0 comments on commit 28f488d

Please sign in to comment.