Skip to content

Commit 9a0e531

Browse files
PhilReedDataPhilReedData
authored
Merge pull request #16 from seek4science/features
Improved Home and Features page, add three new pages
2 parents d7ea8d6 + 7230f6b commit 9a0e531

15 files changed

+138
-33
lines changed

‎_pages/api_and_programmatic_access.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
permalink: /api_and_programmatic_access.html
3+
title: "API and Programmatic Access"
4+
layout: single
5+
---
6+
7+
FAIRDOM-SEEK includes a [JSON](https://www.json.org/) Application Programming Interface (API) that allows the searching, listing, reading, updating and creating of many items in your FAIRDOM-SEEK instance, along with their attributes.
8+
The API supports Basic Authentication, OAuth and API Tokens, and can also be used without any authentication.
9+
10+
![Screenshot of the API in action](/assets/images/api-feature.png){: .screenshot}
11+
12+
FAIRDOM-SEEK supports RDF export (in Turtle format) and can be configured with a SPARQL endpoint. RDF generation will include [Extended Metadata](extended_metadata.html) when present for the attributes that include an identifier, and similarly some basic RDF is generated for Samples.

‎_pages/explore.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
permalink: /explore.html
3+
title: "Explore spreadsheets"
4+
layout: single
5+
redirect_from: '/explore_and_annotate.html'
6+
---
7+
8+
Excel spreadsheets can be explored without the need to download.
9+
10+
The contents of spreadsheets are indexed and searchable - so data can be discovered by searching within their content.
11+
12+
You can explore and view other types of documents in the browser, including PDF, Word, PowerPoint, CSV, text files, and models.
13+
14+
![Excel feature](/assets/images/Excel-feature.png){: .screenshot}

‎_pages/explore_and_annotate.md‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎_pages/extended_metadata.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
permalink: /extended_metadata.html
3+
title: "Extended Metadata"
4+
layout: single
5+
---
6+
7+
Extended Metadata is a feature added to FAIRDOM-SEEK as part of version 1.11, originally to support plant phenotyping [(MIAPPE)](https://github.com/MIAPPE/MIAPPE).
8+
It provides the ability to define additional metadata attributes for a particular type (such as Event, DataFile or Model).
9+
This feature is useful in many other communities who adhere to a particular metadata standard, such as [NFDI4Health](https://fair-dom.org/fairdom-in-use/nfdi4health).
10+
11+
![Screenshot of Extended Metadata Type management](/assets/images/emt-management.png)
12+
13+
[FAIR Data Station](https://fairds.fairbydesign.nl/) integration provides a lightweight approach to gathering, validating, and ingesting metadata through the use of spreadsheet templates and following FAIR principles. Current support includes the matching of metadata attributes configured in FAIR Data Station with those of pre-configured Extended Metadata Types which are then automatically applied.

‎_pages/features.md‎

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,50 @@ redirect_from: '/about.html'
88

99
## Key features
1010

11-
**Data Catalogue** – The data catalogue in FAIRDOM-SEEK includes raw [Datasets](https://fairdomhub.org/data_files), [Documents](https://fairdomhub.org/documents), [Standard Operating Procedures(SOPs)](https://fairdomhub.org/sops), [Models](https://fairdomhub.org/models), [Publications](https://fairdomhub.org/publications) and [Presentations](https://fairdomhub.org/presentations). All data are grouped by projects, and associated with the researchers who produced them. Documents can be put into [collections](https://fairdomhub.org/collections). In order to encourage sharing of data we allow researchers flexibility in the formats they upload and share their data in. This means data formats in the FAIRDOM-SEEK catalogue can vary. We do offer a set of “best practice” guidelines for researchers who want to make their data available and usable to the widest possible audience.
12-
Most common formats allow viewing within the browser, without a download, with additional enhanced features for spreadsheets and SBML models.
13-
Multiple data files can be registered at once by uploading a zip file.
11+
**Data Catalogue** – The data catalogue in FAIRDOM-SEEK includes raw [Datasets](https://fairdomhub.org/data_files), [Documents](https://fairdomhub.org/documents), [Standard Operating Procedures(SOPs)](https://fairdomhub.org/sops), [Models](https://fairdomhub.org/models), [Publications](https://fairdomhub.org/publications) and [Presentations](https://fairdomhub.org/presentations). All data are grouped by projects, and associated with the researchers who produced them. Documents can be put into [collections](https://fairdomhub.org/collections).
12+
13+
In order to encourage [sharing of data](flexible_sharing.html) we allow researchers flexibility in the formats they upload and share their data in. This means data formats in the FAIRDOM-SEEK catalogue can vary. We do offer a set of “best practice” guidelines for researchers who want to make their data available and usable to the widest possible audience.
14+
The sharing policy and permissions for assets can be changed in batch.
1415

15-
All data and information added to FAIRDOM-SEEK is searchable using key-words.
16+
Most common formats allow viewing within the browser, without a download, with additional enhanced features for spreadsheets and SBML models. The contents of [Excel spreadsheets can be explored](explore.html) in the browser.
17+
Multiple data files can be registered at once by uploading a zip file.
18+
All data and information added to FAIRDOM-SEEK is searchable using key-words.
1619

1720
**Versioning** – All data is stored using versioning, selectable privacy, and static URLs. Versioning and privacy settings ensure that you can share your most recent data, with who you choose. Static URLs ensure that you can be credited directly for all shared work.
1821
Individual versions can have their visibility controlled, allowing past versions to be completely hidden if desired.
1922

20-
**Model simulation and annotation** – if models follow the [SBML standard](http://sbml.org/), they can be simulated from within FAIRDOM-SEEK with [JWS Online](http://jjj.mib.ac.uk/).
23+
**Model simulation and annotation** – if models follow the [SBML standard](http://sbml.org/), they can be [simulated from within FAIRDOM-SEEK](simulate_sbml.html) with [JWS Online](http://jjj.mib.ac.uk/).
2124
[COPASI](http://copasi.org/) models can be interpreted and manipulated directly from the browser.
2225
[Morpheus](https://morpheus.gitlab.io/) models can be simulated directly from the browser.
2326

2427
**Access Control** – Data will go through a research lifecycle between collection and publication. In a competitive academic environment it is important that the data can be shared with collaborators, and then the wider community at appropriate points within the life-cycle. FAIRDOM-SEEK allows users to keep their uploaded data entirely private, to share between individuals, then across entire projects, until eventually making it public upon publication.
28+
A gatekeeper role can be assigned to manage sharing of a project's assets.
2529

26-
**People index** – FAIRDOM-SEEK contains an [index of people](https://fairdomhub.org/people) where users can browse, or keyword-search, profiles of the projects, groups and people that contribute to the data on the site. People can describe their areas of expertise, which allows other users to quickly identify the right people to approach regarding specialist enquiries and collaboration proposals.
30+
**People index** – FAIRDOM-SEEK contains an [index of people](yellow_pages.html) where users can browse, or keyword-search, profiles of the projects, groups and people that contribute to the data on the site. People can describe their areas of expertise, which allows other users to quickly identify the right people to approach regarding specialist enquiries and collaboration proposals.
2731
Extra identifying information, such ORCID and affiliation, can be added for each creator, even if they are not registered in FAIRDOM-SEEK.
2832

2933
**Samples** – FAIRDOM-SEEK has a flexible samples framework that allows users to generate templates for sample metadata. Samples can be data, or laboratory samples. The framework integrates with Rightfield sheets, so that semantically-enhanced title sheets can be included with the data. The default Rightfield sheet uses the JERM and allows automatic generation and linking of the data files to an assay.
3034
Sample attributes can be limited to controlled vocabularies backed by an ontology.
3135

32-
**Extended Metadata** – FAIRDOM-SEEK allows items to be customized with additional typed metadata, similar to samples, and was used to support [MIAPPE](https://www.miappe.org/).
36+
**Extended Metadata** – FAIRDOM-SEEK allows items to be customized with [additional typed metadata](extended_metadata.html), similar to samples, and was used to support [MIAPPE](https://www.miappe.org/).
3337
Extended Metadata can be nested, i.e one Extended Metadata type definition can include a reference to another, and these will be nested together in a single form.
3438

3539
**ISA and Interlinking** – Data in FAIRDOM-SEEK gain increased value and usability when they are described within the context of an experimental process.
3640
Multiple experiments will be carried out as part of a single Study, and that study may be part of a wider overall funded Investigation.
37-
In FAIRDOM-SEEK we adopt the [ISATAB structure (Investigation, Studies, Assays)](https://isa-tools.org/) which is a community standard for describing links between Omics experiments.
41+
In FAIRDOM-SEEK we adopt the [ISATAB structure (Investigation, Studies, Assays)](organise.html) which is a community standard for describing links between Omics experiments.
3842
We believe that many aspects of the ISA framework are equally appropriate for describing experiments beyond Omics and Biology, so allow this framework to be applied to all data.
3943

4044
Beyond the ISA framework, FAIRDOM-SEEK allows data to be interlinked within the site itself in order to describe their relationship.
4145

42-
If research resulted in a publication, this can also be registered with FAIRDOM-SEEK (including accreditation to relevant people) using a [PUBMED](http://www.ncbi.nlm.nih.gov/pubmed) identifier or [DOI](http://www.doi.org/),
46+
**Publishing and licensing** – If research resulted in a [publication](publishing_and_doi.html), this can also be registered with FAIRDOM-SEEK (including accreditation to relevant people) using a [PUBMED](http://www.ncbi.nlm.nih.gov/pubmed) identifier or [DOI](http://www.doi.org/),
4347
and linked to the assets involved in that research – allowing other researchers access to use, examine, or validate the data that would otherwise be unavailable through the publication alone.
48+
FAIRDOM-SEEK can be set up as [registration hub](publishing_and_doi.html) for your publications and issue DOIs.
49+
50+
We recommended giving a license to public resources in FAIRDOM-SEEK to clarify under what terms they may be used. A Project administrator may specify the default license for their project which is automatically selected when creating a new item, but can be changed by the user if necessary.
51+
52+
**API and programmatic access** – The [JSON API](api_and_programmatic_access.html) allows the searching, listing, reading, updating and creating of many items in your FAIRDOM-SEEK instance, along with their attributes. FAIRDOM-SEEK supports RDF export (in Turtle format) and can be configured with a SPARQL endpoint.
53+
54+
**Bioschemas support** – A **sitemap.xml** is generated for all public content, improving indexing by the main search engines, and supports [Bioschemas](https://bioschemas.org/) scraping. Bioschemas (and therefore [schema.org](https://schema.org/)) metadata is generated for each asset type in FAIRDOM-SEEK, using the common Bioschemas profiles such as Project, Sample and DataSet.
4455

4556
## Bespoke Development
4657

‎_pages/index.md‎

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ row1:
1212
excerpt: "FAIRDOM-SEEK has adopted an ISATAB style structure for organising experiments and data."
1313
url: "/organise.html"
1414
- image_path: /assets/images/Excel-feature.png
15-
alt: "Explore and annotate"
16-
title: "Explore and annotate data"
17-
excerpt: "Excel spreadsheets can be explored and annotated without the need to download."
18-
url: "/explore_and_annotate.html"
15+
alt: "Explore spreadsheets"
16+
title: "Explore spreadsheets"
17+
excerpt: "Excel spreadsheets and other documents can be explored without the need to download."
18+
url: "/explore.html"
1919
- image_path: /assets/images/Model-simulation-feature.png
2020
alt: "Simulate SBML"
2121
title: "Simulate SBML models"
22-
excerpt: "Most models that conforms to the SBML format can be simulated within FAIRDOM-SEEK."
22+
excerpt: "Most models that conforms to the SBML, COPASI or Morpheus formats can be simulated within FAIRDOM-SEEK."
2323
url: "/simulate_sbml.html"
2424

2525
row2:
@@ -39,7 +39,22 @@ row2:
3939
excerpt: "RightField enabled sheets allow rich semantic descriptions of data. Our Just Enough Results Model can be used with Rightfield."
4040
url: "/rightfield_templates.html"
4141

42-
42+
row3:
43+
- image_path: /assets/images/emt-management.png
44+
alt: "Extended Metadata Types management"
45+
title: "Extended Metadata"
46+
excerpt: "Define additional metadata attributes for a particular type, adhere to standards."
47+
url: "/extended_metadata.html"
48+
- image_path: /assets/images/DOI_logo.svg
49+
alt: "DOI logo"
50+
title: "Publishing and DOI"
51+
excerpt: "Set up a registration hub for your publications, manage DOIs."
52+
url: "/publishing_and_doi.html"
53+
- image_path: /assets/images/api-feature.png
54+
alt: "API feature"
55+
title: "API and programmatic access"
56+
excerpt: "The JSON API allows the searching, listing, reading, updating and creating. FAIRDOM-SEEK supports RDF export."
57+
url: "/api_and_programmatic_access.html"
4358
---
4459

4560

@@ -73,3 +88,5 @@ A publicly available instance of a FAIRDOM-SEEK commons is available - as the [F
7388
{% include feature_row id="row1" %}
7489

7590
{% include feature_row id="row2" %}
91+
92+
{% include feature_row id="row3" %}

‎_pages/organise.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ layout: single
66

77
FAIRDOM-SEEK has adopted an ISATAB style structure for organising experiments and data.
88

9-
The ISA format (Investigations, Studies and Assays) is a community standardisation activity to allow the association of multiple 'Omics datasets, in the context of the experiments that created them, in order to make it easier to compare and combine different data sets. It also provides the possibility of exporting or importing data from other sources in ISA-TAB format and therefore allows data exchange with a wider community.
9+
The [ISATAB format (Investigation, Studies, Assays)](https://isa-tools.org/) is a community standardisation activity to allow the association of multiple 'Omics datasets, in the context of the experiments that created them, in order to make it easier to compare and combine different data sets. It also provides the possibility of exporting or importing data from other sources in ISA-TAB format and therefore allows data exchange with a wider community.
1010

1111

1212
![ISA Graph](/assets/images/ISA-feature.png){: .screenshot}

‎_pages/publishing_and_doi.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
permalink: /publishing_and_doi.html
3+
title: "Publishing and DOI"
4+
layout: single
5+
---
6+
7+
If research resulted in a publication, this can also be registered with FAIRDOM-SEEK (including accreditation to relevant people) using a [PUBMED](http://www.ncbi.nlm.nih.gov/pubmed) identifier or [DOI](http://www.doi.org/),
8+
and linked to the assets involved in that research – allowing other researchers access to use, examine, or validate the data that would otherwise be unavailable through the publication alone.
9+
10+
FAIRDOM-SEEK can be set up as registration hub for your publications.
11+
Research outputs can be assigned a persistent identifier, making them findable by a unique URL.
12+
For example, materials shared on [FAIRDOMHub](https://fair-dom.org/fairdom-in-use/fairdomhub) (a public hub) can be issued with a DOI.
13+
14+
![DOI logo](/assets/images/DOI_logo.svg)
15+
16+
If you set up your own hub and wish to issue DOIs, you will need to [become a member of DataCite](https://datacite.org/become-a-member/) (see their [fee model](https://datacite.org/fee-model/)).
17+

‎_pages/simulate_sbml.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
permalink: /simulate_sbml.html
3-
title: "Simulate SBML models"
3+
title: "Simulate SBML, COPASI and Morpheus models"
44
layout: single
55
---
66

@@ -10,4 +10,10 @@ The [JWS Online](http://jjj.mib.ac.uk/) model simulator presents a schematic dia
1010

1111

1212

13-
![Simulate_SBML feature](/assets/images/Model-simulation-feature.png){: .screenshot}
13+
![Simulate_SBML feature](/assets/images/Model-simulation-feature.png){: .screenshot}
14+
15+
[COPASI](http://copasi.org/) models can be interpreted and manipulated directly from the browser or using your local installation of COPASI.
16+
17+
![Simulate COPASI model](/assets/images/copasi-model-browser.png){: .screenshot}
18+
19+
[Morpheus](https://morpheus.gitlab.io/) models can be simulated directly from the browser.

‎_pages/yellow_pages.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,15 @@ layout: single
66

77
We recognise that people, and their knowledge, are important.
88

9-
You can find out what people using, and have expertise in, and how to get in contact with them.
9+
You can find out [what people are using](https://fairdomhub.org/people), and have expertise in, and how to get in contact with them.
1010

1111
The Yellow Pages is a directory of who is on which project, where they are located, and what they specialise in. This allows researchers to identify people with similar interests, or to find people with the relevant experience when troubleshooting new techniques.
1212

13-
With a quick glance it also is possible to see what items they have been involved with producing, what experiments they have been doing, and what registered publications they are an author of.
13+
With a quick glance it also is possible to see what items they have been involved with producing, what experiments they have been doing, and what registered publications they are an author of. For people who have provided their [ORCID](https://info.orcid.org/what-is-orcid/), you can click through to view their wider publishing record.
1414

1515

1616

17-
![Yellow_pages feature](/assets/images/Who-feature.png){: .screenshot}
17+
![Yellow_pages feature](/assets/images/Who-feature.png){: .screenshot}
18+
19+
We recognise that the institutions people work for are important too. For each person, you can assign an [ROR](https://ror.org/about/), a persistent identifier for research institutions.
20+
ROR makes it easier to disambiguate institution names and connect research organisations to researchers and research outputs.

0 commit comments

Comments
 (0)