Skip to content

Commit

Permalink
enhancing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
markwilkinson committed Jan 4, 2024
1 parent e53450f commit e89aa2c
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 6 deletions.
4 changes: 2 additions & 2 deletions SemanticModel/CSV/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Location:

- filename: location.csv
- yarrrml: location_yarrrml.yaml
- yarrrml: location_yarrrml.pre-yaml

**bgvid**: string

Expand Down Expand Up @@ -34,7 +34,7 @@
## Germplasm:

- filename: germplasm.csv
- yarrrml: germplasm.yaml
- yarrrml: germplasm.pre-yaml

**bgvid**: string

Expand Down
45 changes: 45 additions & 0 deletions SemanticModel/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<H1>Semantic Model and Template Based Transformation Pipeline</H1>

Jump to:<br/>
<a href="#model">Model</a><br/>
<a href="#pipeline">Pipeline</a>

<h2 id="model">Semantic Model</h2>

The FLAIR-GG Semantic Model is broken into 3 parts:<br/>
<ul>

<li>Location Information: The site of collection</li>
<li>Germplasm Information: Species, taxon, phenotype, etc.</li>
<li>Administrative: Who collected it, where is it stored, are there duplicates, species-at-risk, etc.</li>

</ul>

<h3>Location</h3>

<a href="./YARRRML/location_yarrrml.pre-yaml">[YARRRML Here]</a>
<br/><br/>
<img src="./Images/Location%20Data%20Model.png"/>


<h3>Germplasm Information</h3>

Coming soon!

<h3>Administrative</h3>


<a href="./YARRRML/administrative_yarrrml.pre-yaml">[YARRRML Here]</a>
<br/><br/>
<img src="./Images/Administrative%20Data%20Model.png"/>

<br/><br/>
<hr/>
<h2 id="model">Transformation Pipeline</h2>

Transformation of "native" data formats into RDF formats is accomplished via a <a href="SemanticModel/CSV/README.md">set of CSV templates</a>.

<br/>
Each CSV template is paired with an equivalent <a href="https://rml.io/yarrrml/">YARRRML</a> template, and data transformation is accomplished using
a customized version of <a href="https://github.com/ejp-rd-vp/yarrrml-rmlmapper-docker-ejp">yarrrml-rmlmapper-docker</a> (originally from the
team at <a href="https://github.com/RMLio/yarrrml-rmlmapper-docker">RML.io</a>)
Binary file added VP/images/ted-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 33 additions & 4 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,23 @@ <h2>Links for the FLAIR-GG Virtual Platform</h2>
<br/>
<br/>
<h3>General Documentation</h3>
<ul>
<li><a href="./VP/index.html">VP Documentation</a></li>
<li><a href="https://wilkinsonlab.github.io/multi-crop-passport-descriptor-ontology/multi-passport-descriptor.owl">FAO Multi Passport Descriptor Ontology</a></li>
</ul>

<p>The FLAIR-GG Project aims to <a href="https://www.go-fair.org/fair-principles/">FAIRify</a> the <a href="http://www.bancodegermoplasma.upm.es/">
Banco de Germoplasma Vegetal de la Universidad Politécnica de Madrid (BGV)</a> and to interlink it with other Germplasm resources throughout Spain and the world.</p>

<p>This will be accomplished using a variety of technologies for modelling and transforming relational data from the BGV into FAIR formats such as ontologically grounded RDF
</p>

<p>All germplasm resources will be connected via a shared portal called the "Virtual Platform" (VP), where it will be possible to execute federated queries over
all participants in the FLAIR-GG network </p>

<h3>Component Documentation</h3>
<ul>
<li><a href="./SemanticModel/index.html">Termplate-based transformation pipeline</a></li>

<li><a href="./VP/index.html">VP Documentation</a></li>
<li><a href="https://wilkinsonlab.github.io/multi-crop-passport-descriptor-ontology/multi-passport-descriptor.owl">FAO Multi Passport Descriptor Ontology</a></li>
</ul>
<br/>
<br/>
<h3>OpenAPI YAML Interfaces for BGV services</h3>
Expand All @@ -19,3 +32,19 @@ <h3>Swagger tester for interfaces</h3>
<ul>
<li><a href="https://bgv.cbgp.upm.es/swagger">Swagger-UI</a></li>
</ul>


<h3>Funding</h3>

<b>TED2021-130788B-I00</b>
<br/>
<img width="300" src="./VP/images/ted-logo.png" />
<br/>

Moreno Vazquez, Santiago<br/>
UPM. Biodiversidad y conservación de recursos fitogenéticos (Grupo de investigacion)
<br/><br/>
Wilkinson, Mark Denis <br/>
Abordajes Multidisciplinares en la Interfaz Planta-Microorganismo (Grupo de investigacion)<br/>


0 comments on commit e89aa2c

Please sign in to comment.