Skip to content

Commit

Permalink
udpating link as repo moved
Browse files Browse the repository at this point in the history
  • Loading branch information
bryan-brancotte authored Jun 23, 2021
1 parent 69b8427 commit 6ecde70
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions paper_resources/long_paper_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,13 @@ The EDAM Browser is publicly available (criteria 1) and does not require authent

##### Criteria 3 - "Display of multiple parents"

Multiple parents are handled (see [for instance the link to the Phylogeny topic](https://ifb-elixirfr.github.io/edam-browser/#topic_0084)). In order to improve readability when a term is selected (1) all the term's positions are shown; and (2) all paths from the root node are highlighted (cf Fig. 1).
Multiple parents are handled (see [for instance the link to the Phylogeny topic](https://edamontology.github.io/edam-browser/#topic_0084)). In order to improve readability when a term is selected (1) all the term's positions are shown; and (2) all paths from the root node are highlighted (cf Fig. 1).

![The term Phylogeny has two parents](topics_tree_phylogeny.png)

##### Criteria 4 - "Can be integrated in external websites"

The ability to integrate the EDAM Browser, and its tree representation is major requirement, in order to help third party websites promoting their resources when labeled with EDAM. Both the autocomplete input field and the tree visualization are re-usable. To highlight this statement we propose a dynamic [demo](https://ifb-elixirfr.github.io/edam-browser/demo.html) showing how it can be integrated, how the user can interact with the tree, and how to programmaticaly interact with the tree in JavaScript.
The ability to integrate the EDAM Browser, and its tree representation is major requirement, in order to help third party websites promoting their resources when labeled with EDAM. Both the autocomplete input field and the tree visualization are re-usable. To highlight this statement we propose a dynamic [demo](https://edamontology.github.io/edam-browser/demo.html) showing how it can be integrated, how the user can interact with the tree, and how to programmaticaly interact with the tree in JavaScript.

##### Criteria 5 - "Facilitate community contributions"

Expand All @@ -115,7 +115,7 @@ Letting users contribute to the ontology improves acceptance by the community as

##### Criteria 6 - "Use edited version of EDAM"

Using the EDAM Browser to explore an local or development version is possible. The ontology should be in the following simplified schema which is expressed in [json schema](http://json-schema.org/). A complete version of the schema is accessible [here](https://ifb-elixirfr.github.io/edam-browser/ontology.schema.json) and an example file is [there](https://ifb-elixirfr.github.io/edam-browser/media/regular.example.json). The [edam2json utility](https://github.com/edamontology/edam2json) can be used to generate the ontology in this format from any EDAM owl file.
Using the EDAM Browser to explore an local or development version is possible. The ontology should be in the following simplified schema which is expressed in [json schema](http://json-schema.org/). A complete version of the schema is accessible [here](https://edamontology.github.io/edam-browser/ontology.schema.json) and an example file is [there](https://edamontology.github.io/edam-browser/media/regular.example.json). The [edam2json utility](https://github.com/edamontology/edam2json) can be used to generate the ontology in this format from any EDAM owl file.

<!--- https://app.quicktype.io/#l=schema helps generating schema--->

Expand Down Expand Up @@ -143,7 +143,7 @@ The resulting file is loaded directly to the EDAM Browser by clicking on the but
![Providing a custom ontology](custom_ontology.png)


Filling this form with the url of the example file and indicating that the identifier is accessible with `d.id` will (i) open the given file and (ii) change the url such that this configuration can be bookmarked and reopen later : [resulting link](https://ifb-elixirfr.github.io/edam-browser/?url=https%3A%2F%2Fraw.githubusercontent.com%2FIFB-ElixirFr%2Fedam-browser%2Fmaster%2Fmedia%2Fregular.example.json&identifier_accessor=d.id&text_accessor=d.text#p9&custom_url).
Filling this form with the url of the example file and indicating that the identifier is accessible with `d.id` will (i) open the given file and (ii) change the url such that this configuration can be bookmarked and reopen later : [resulting link](https://edamontology.github.io/edam-browser/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fedamontology%2Fedam-browser%2Fmaster%2Fmedia%2Fregular.example.json&identifier_accessor=d.id&text_accessor=d.text#p9&custom_url).

##### Criteria 7 - "Local installation"

Expand All @@ -164,7 +164,7 @@ The tree-based visualization of the EDAM Browser uses [d3.js](https://d3js.org/)
[Towards Updatable D3.js Charts](https://www.toptal.com/d3-js/towards-reusable-d3-js-charts) and
[Towards Reusable Charts](https://bost.ocks.org/mike/chart/). It allows us to encapsulate the inner mechanics and variables of the tree while exposing methods to configure the chart and interact with it. Configuration encompasses the animation duration, if the tooltip should be used, and how we construct the html code of the tooltip. Interaction encompasses altering the elements selection, and collapsing node.

The following example comes from the [demo](https://ifb-elixirfr.github.io/edam-browser/demo.html) and shows how to visualize the ontology at `media/topic_extended.biotools.min.json` in the div `#tree` with the `Bioinformatics` term initially selected ; and after one second the element `Metagenomics` is added to the selection. Note that as the format of the file does not follow the recommendation, we have to provide a new method to access the identifier.
The following example comes from the [demo](https://edamontology.github.io/edam-browser/demo.html) and shows how to visualize the ontology at `media/topic_extended.biotools.min.json` in the div `#tree` with the `Bioinformatics` term initially selected ; and after one second the element `Metagenomics` is added to the selection. Note that as the format of the file does not follow the recommendation, we have to provide a new method to access the identifier.

```javascript
my_tree = interactive_tree()
Expand Down

0 comments on commit 6ecde70

Please sign in to comment.