Skip to content

Commit

Permalink
Merge branch 'main' of github.com:wilkinsonlab/FLAIR-GG into main
Browse files Browse the repository at this point in the history
  • Loading branch information
markwilkinson committed Mar 22, 2024
2 parents 42ea672 + 3ad2bd3 commit 624da63
Show file tree
Hide file tree
Showing 15 changed files with 276 additions and 156 deletions.
37 changes: 21 additions & 16 deletions Onboarding/En Documentation/Catalog.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
[![Static Badge](https://img.shields.io/badge/lang-es-yellow?style=plastic)](../Es%20Documentation/Catalog.es.md)
# Catalog
Describes a catalog of datasets and data services. It is possible that a
catalog can consist of catalogs as well. To be meaningful a catalog must consist of at least 1 dataset, data service, or otherwise 1 or more catalogs.

Describes a catalog of datasets and data services. To be meaningful a catalog must consist of at least 1 dataset or data service.
### Legend:
- ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) This column is **MANDATORY**
- ![](https://placehold.jp/17/ea9999/000000/20x20.png?text=R) This column is **RECOMMENDED**
Expand All @@ -29,15 +27,14 @@ Germplasm Bank Collections
## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Publisher
Pointer to the Organisation that published the
resource (from the Organisation sheet; a dropdown list will appear).
resource (from the Organisation sheet; a dropdown list will appear, allowing you to select from pre-established options).

*Example:*
César Gómez Campo Banco de Germoplasma Vegetal de la UPM


## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Personal Data
Set to "true" if the resource onboarded to
the Virtual Platform contains personal
Set to "true" if this resource contains personal
data, personal data meaning data
related to identified or identifiable
persons (as per GDPR definition),
Expand All @@ -60,7 +57,7 @@ In most cases, this will be https://schema.org/catalog (Catalog)


## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Contact Point
Pointer to a Contact Point (from the Contact Point sheet; a dropdown list will appear)
Pointer to a Contact Point (from the Contact Point sheet; a dropdown list will appear, allowing you to select from pre-established options)

*Example:*
http://www.bancodegermoplasma.upm.es/
Expand All @@ -69,9 +66,7 @@ http://www.bancodegermoplasma.upm.es/
## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Language
An ISO 639-1 two-letter code for the
languages this patient registry is provided
in. Example: en indicates that this patient
registry is available in English. The range is
an xsd:string. The ISO language codes
in. The ISO language codes
can be found at:
[https://id.loc.gov/vocabulary/iso639-1.html](https://id.loc.gov/vocabulary/iso639-1.html)

Expand Down Expand Up @@ -108,8 +103,7 @@ https://fdp.bgv.cbgp.upm.es/dataset/f7600b9f-cd18-4122-86c6-b6f5a75ecc03, https:

## ![](https://placehold.jp/17/ffffff/000000/20x20.png?text=O) Theme Taxonomy
Points to an URL that specifies relevant concepts that classify the **contents of the catalog**. They must be ontological terms, and typically, these can be looked
up using the [Ontology Lookup Service (OLS)](https://www.ebi.ac.uk/ols4/index) or [Bioportal](https://bioportal.bioontology.org/). In the case of species names, we recommend using the [World Flora Online Taxonomy](https://www.worldfloraonline.org/search?query=)
Points to an URL that specifies relevant concepts that classify the **contents of the catalog** (they are basically Keywords for computers). The best concepts to include here are what you think make your resource unique, what the users might find most interesting about your resource. They must be ontological terms, and typically, these can be looked up using the [Ontology Lookup Service (OLS)](https://www.ebi.ac.uk/ols4/index) or [Bioportal](https://bioportal.bioontology.org/). In the case of species names, we recommend using the [World Flora Online Taxonomy](https://www.worldfloraonline.org/search?query=).

*Example:*
https://www.worldfloraonline.org/taxon/wfo-0000659225, https://www.worldfloraonline.org/taxon/wfo-0000729203, https://www.worldfloraonline.org/taxon/wfo-0000729205, https://www.worldfloraonline.org/taxon/wfo-4000000074
Expand All @@ -131,12 +125,13 @@ that you wish the VP to explore
NOT Dataset Z). If you do not add
this tag to at least the description of
your resource, you will not be
onboarded.
The value is [https://w3id.org/ejp-rd/vocabulary#VPDiscoverable](https://w3id.org/ejp-rd/vocabulary#VPDiscoverable) (a dropdown list will appear)
onboarded to the virtual platform.
The value is [https://w3id.org/ejp-rd/vocabulary#VPDiscoverable](https://w3id.org/ejp-rd/vocabulary#VPDiscoverable) (a dropdown list will appear, allowing you to select from pre-established options)


## ![](https://placehold.jp/17/ffffff/000000/20x20.png?text=O) Keyword
Keywords applicable to this catalog
Keywords applicable to this catalog. The best concepts to include here are what you think make your resource unique, what the users might find most interesting about your resource.


*Example:*
Germplasm
Expand All @@ -152,7 +147,7 @@ of this resource.

## ![](https://placehold.jp/17/ffffff/000000/20x20.png?text=O) Distribution
Use this property to point to the distribution of this
catalog when a distribution is available (from the Distribution sheet; a dropdown list will appear)
catalog when a distribution is available (from the Distribution sheet; a dropdown list will appear, allowing you to select from pre-established options)

*Example:*
SPARQL distribution of Administrative data
Expand Down Expand Up @@ -207,3 +202,13 @@ MAGE-ML for Microarray data).
https://w3id.org/bgv-fdp/profile/a0949e72-4466-4d53-8900-9436d1049a4b


<br />
<br />

<div align="center">

<a href="">[![Static Badge](https://img.shields.io/badge/Previous%20Sheet-Distribution-yellow?style=for-the-badge)](./Distribution.md)</a>
<a href="">[![Static Badge](https://img.shields.io/badge/Home-README-blue?style=for-the-badge)](../README.md)</a>
<a href="">[![Static Badge](https://img.shields.io/badge/Next%20Sheet-Dataservice-green?style=for-the-badge)](./DataService.md)</a>

</div>
14 changes: 13 additions & 1 deletion Onboarding/En Documentation/ContactPoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,16 @@ Provides contact information for a metadata resource.
Link to the contact point for the resource. Can be an email address or a link to a website you can send communication requests to.

*Example:*
http://www.bancodegermoplasma.upm.es/
http://www.bancodegermoplasma.upm.es/


<br />
<br />

<div align="center">

<a href="">[![Static Badge](https://img.shields.io/badge/Previous%20Sheet-Organisation-yellow?style=for-the-badge)](./Organisation.md)</a>
<a href="">[![Static Badge](https://img.shields.io/badge/Home-README-blue?style=for-the-badge)](../README.md)</a>
<a href="">[![Static Badge](https://img.shields.io/badge/Next%20Sheet-Dataset-green?style=for-the-badge)](./Dataset.md)</a>

</div>
37 changes: 23 additions & 14 deletions Onboarding/En Documentation/DataService.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ In most cases, this will be http://edamontology.org/format_3790 (SPARQL)


## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Title
The name of the Data Service. This is a
required field and needs to be unique.
The name of the Data Service. This field needs to be unique.

*Example:*
SPARQL distribution of Administrative data
Expand All @@ -55,8 +54,7 @@ Administrative data distributed via a public SPARQL endpoint


## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Personal Data
Set to "true" if the resource onboarded to
the Virtual Platform contains personal
Set to "true" if this resource contains personal
data, personal data meaning data
related to identified or identifiable
persons (as per GDPR definition),
Expand All @@ -66,14 +64,15 @@ otherwise "false".
## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Publisher
Pointer to the Organisation that published the
resource (from the Organisation sheet; a dropdown list will appear).
resource (from the Organisation sheet; a dropdown list will appear, allowing you to select from pre-established options).

*Example:*
César Gómez Campo Banco de Germoplasma Vegetal de la UPM


## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Theme
Points to an URL that specifies relevant concepts that classify the resource. They must be ontological terms, and typically, these can be looked

Points to an URL that specifies relevant concepts that classify the Data Service (they are basically Keywords for computers). The best concepts to include here are what you think make your resource unique, what the users might find most interesting about your resource. They must be ontological terms, and typically, these can be looked
up using the [Ontology Lookup Service (OLS)](https://www.ebi.ac.uk/ols4/index) or [Bioportal](https://bioportal.bioontology.org/).

In most cases, this will be http://edamontology.org/format_3790 (SPARQL)
Expand All @@ -84,9 +83,7 @@ In most cases, this will be http://edamontology.org/format_3790 (SPARQL)
## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Language
An ISO 639-1 two-letter code for the
languages this patient registry is provided
in. Example: en indicates that this patient
registry is available in English. The range is
an xsd:string. The ISO language codes
in. The ISO language codes
can be found at:
[https://id.loc.gov/vocabulary/iso639-1.html](https://id.loc.gov/vocabulary/iso639-1.html)

Expand All @@ -96,8 +93,9 @@ en




## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Contact Point
Pointer to a Contact Point (from the Contact Point sheet; a dropdown list will appear)
Pointer to a Contact Point (from the Contact Point sheet; a dropdown list will appear, allowing you to select from pre-established options)

*Example:*
http://www.bancodegermoplasma.upm.es/
Expand Down Expand Up @@ -137,8 +135,8 @@ that you wish the VP to explore
NOT Dataset Z). If you do not add
this tag to at least the description of
your resource, you will not be
onboarded.
The value is [https://w3id.org/ejp-rd/vocabulary#VPDiscoverable](https://w3id.org/ejp-rd/vocabulary#VPDiscoverable) (a dropdown list will appear)
onboarded to the virtual platform.
The value is [https://w3id.org/ejp-rd/vocabulary#VPDiscoverable](https://w3id.org/ejp-rd/vocabulary#VPDiscoverable) (a dropdown list will appear, allowing you to select from pre-established options)



Expand All @@ -152,7 +150,7 @@ representation of this resource.
## ![](https://placehold.jp/17/ffffff/000000/20x20.png?text=O) Serves Dataset
Used to indicate which dataset
a DataService is serving data
from (from the Dataset sheet; a dropdown list will appear)
from (from the Dataset sheet; a dropdown list will appear, allowing you to select from pre-established options)

*Example:*
BGV June 2023
Expand All @@ -163,7 +161,8 @@ BGV June 2023

## ![](https://placehold.jp/17/ffffff/000000/20x20.png?text=O) Keyword
Keywords applicable to this
data service
data service. The best keywords to include here are what you think make your resource unique, what the users might find most interesting about your resource.


*Example:*
Germplasm, SPARQL
Expand Down Expand Up @@ -207,4 +206,14 @@ identifier) of a resource.
*Example:*
4.11.2

<br />
<br />

<div align="center">

<a href="">[![Static Badge](https://img.shields.io/badge/Previous%20Sheet-Catalog-yellow?style=for-the-badge)](./Catalog.md)</a>
<a href="">[![Static Badge](https://img.shields.io/badge/Home-README-blue?style=for-the-badge)](../README.md)</a>


</div>

39 changes: 27 additions & 12 deletions Onboarding/En Documentation/Dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ Metadata snapshot of BGV taken in June 2023


## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Theme
Points to an URL that specifies relevant concepts that classify the resource. They must be ontological terms, and typically, these can be looked

Points to an URL that specifies relevant concepts that classify the Dataset (they are basically Keywords for computers). The best concepts to include here are what you think make your resource unique, what the users might find most interesting about your resource.
They must be ontological terms, and typically, these can be looked
up using the [Ontology Lookup Service (OLS)](https://www.ebi.ac.uk/ols4/index) or [Bioportal](https://bioportal.bioontology.org/). In the case of species names, we recommend using the [World Flora Online Taxonomy](https://www.worldfloraonline.org/search?query=)

*Example:*
Expand All @@ -46,30 +48,32 @@ https://www.worldfloraonline.org/taxon/wfo-0000481006

## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Publisher
Pointer to the Organisation that published the
resource (from the Organisation sheet; a dropdown list will appear).
resource (from the Organisation sheet; a dropdown list will appear, allowing you to select from pre-established options).

*Example:*
César Gómez Campo Banco de Germoplasma Vegetal de la UPM


## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Contact Point
Pointer to a Contact Point (from the Contact Point sheet; a dropdown list will appear)
Pointer to a Contact Point (from the Contact Point sheet; a dropdown list will appear, allowing you to select from pre-established options)

*Example:*
http://www.bancodegermoplasma.upm.es/


## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) PersonalData
Set to "true" if the resource onboarded to the Virtual Platform contains personal data, personal data
meaning data related to indentified or identifiable persons (as per GDPR definition), otherwise "false".
Set to "true" if this resource contains personal
data, personal data meaning data
related to identified or identifiable
persons (as per GDPR definition),
otherwise "false".



## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Language
An ISO 639-1 two-letter code for the
languages this patient registry is provided
in. Example: en indicates that this patient
registry is available in English. The range is
an xsd:string. The ISO language codes
in. The ISO language codes
can be found at:
[https://id.loc.gov/vocabulary/iso639-1.html](https://id.loc.gov/vocabulary/iso639-1.html)

Expand All @@ -80,6 +84,7 @@ en




## ![](https://placehold.jp/17/ea9999/000000/20x20.png?text=R) Access Rights
Information about who can access the
resource or an indication of its security status.
Expand All @@ -99,7 +104,7 @@ https://fdb.bgv.cbgp.upm.es/

## ![](https://placehold.jp/17/ffffff/000000/20x20.png?text=O) Distribution

Pointer to the distribution (from the distribution sheet; a dropdown list will appear) for this dataset.
Pointer to the distribution (from the distribution sheet; a dropdown list will appear, allowing you to select from pre-established options) for this dataset.

*Example:*
BGV Germplasm SPARQL distribution
Expand All @@ -113,13 +118,13 @@ that you wish the VP to explore
NOT Dataset Z). If you do not add
this tag to at least the description of
your resource, you will not be
onboarded.
The value is [https://w3id.org/ejp-rd/vocabulary#VPDiscoverable](https://w3id.org/ejp-rd/vocabulary#VPDiscoverable) (a dropdown list will appear)
onboarded to the virtual platform.
The value is [https://w3id.org/ejp-rd/vocabulary#VPDiscoverable](https://w3id.org/ejp-rd/vocabulary#VPDiscoverable) (a dropdown list will appear, allowing you to select from pre-established options)



## ![](https://placehold.jp/17/ffffff/000000/20x20.png?text=O) Keyword
Keywords applicable to this Dataset
Keywords applicable to this Dataset. The best keywords to include here are what you think make your resource unique, what the users might find most interesting about your resource.

*Example:*
Papaver rhoeas
Expand Down Expand Up @@ -179,3 +184,13 @@ MAGE-ML for Microarray data).
*Example:*
https://fdp.bgv.cbgp.upm.es/profile/2f08228e-1789-40f8-84cd-28e3288c3604

<br />
<br />

<div align="center">

<a href="">[![Static Badge](https://img.shields.io/badge/Previous%20Sheet-ContactPoint-yellow?style=for-the-badge)](./ContactPoint.md)</a>
<a href="">[![Static Badge](https://img.shields.io/badge/Home-README-blue?style=for-the-badge)](../README.md)</a>
<a href="">[![Static Badge](https://img.shields.io/badge/Next%20Sheet-Distribution-green?style=for-the-badge)](./Distribution.md)</a>

</div>
20 changes: 16 additions & 4 deletions Onboarding/En Documentation/Distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The SPARQL distribution of the BGV Germplasm data

## ![](https://placehold.jp/17/ff0000/000000/20x20.png?text=M) Publisher
Pointer to the Organisation that published the
resource (from the Organisation sheet; a dropdown list will appear).
resource (from the Organisation sheet; a dropdown list will appear, allowing you to select from pre-established options).

*Example:*
César Gómez Campo Banco de Germoplasma Vegetal de la UPM
Expand Down Expand Up @@ -66,7 +66,7 @@ In most cases, it will be "Contact the owner/curator of this resource to determi
If you have more than one media type
available for your resource and you wish to
make them all accessible, you need to add
another “Distribution”. A dropdown list will appear and let you choose from the pre-set list of media types.
another “Distribution”. a dropdown list will appear, allowing you to select from pre-established options and let you choose from the pre-set list of media types.

*Example:*
sparql-results+json
Expand All @@ -88,7 +88,19 @@ Whether the data can be accessed or downloaded

## ![](https://placehold.jp/17/ffffff/000000/20x20.png?text=O) AccessService

Pointer to the Access Service
Pointer to the Access Service that makes the data available through this distribution (from the Data Service shee, a dropdown list will appear, allowing you to select from pre-established options and let you choose from the pre-set list of media types)

*Example:*
http://edamontology.org/format_3790
http://edamontology.org/format_3790

<br />
<br />

<div align="center">

<a href="">[![Static Badge](https://img.shields.io/badge/Previous%20Sheet-Dataset-yellow?style=for-the-badge)](./Dataset.md)</a>
<a href="">[![Static Badge](https://img.shields.io/badge/Home-README-blue?style=for-the-badge)](../README.md)</a>
<a href="">[![Static Badge](https://img.shields.io/badge/Next%20Sheet-Catalog-green?style=for-the-badge)](./Catalog.md)</a>

</div>

9 changes: 9 additions & 0 deletions Onboarding/En Documentation/Organisation.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,14 @@ ROR standard to identify your organisation, or the link to your FAIR Data Point.
*Example:*
https://w3id.org/bgv-fdp

<br />
<br />

<div align="center">

<a href="">[![Static Badge](https://img.shields.io/badge/Previous%20Sheet-README-yellow?style=for-the-badge)](../README.md)</a>
<a href="">[![Static Badge](https://img.shields.io/badge/Home-README-blue?style=for-the-badge)](../README.md)</a>
<a href="">[![Static Badge](https://img.shields.io/badge/Next%20Sheet-ContactPoint-green?style=for-the-badge)](./ContactPoint.md)</a>

</div>

Loading

0 comments on commit 624da63

Please sign in to comment.