Skip to content

Commit

Permalink
Merge pull request #114 from oda-hub/extra-metadata-doc
Browse files Browse the repository at this point in the history
Extra metadata doc
  • Loading branch information
burnout87 authored Aug 23, 2024
2 parents 5e3ae50 + 2d1a270 commit 2d19f90
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
Binary file added content/docs/grouped_params.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions content/docs/guide-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,26 @@ if credentials_env:
```

## Annotations for the visualization over the Mmoda interface

A number of annotations, for the correspondent visualization over the mmoda frontend, are available:

* `oda:label`: to specify the title for the parameter
* `oda:description`: to specify a tooltip, displayed when we over, with the mouse, over the parameter itself
* `oda:group`: to visually group together a set of parameters horizontally

In the example code below we add these additional metadata annotations:

```
param_1 = '' # http://odahub.io/ontology#String ; oda:label "First" ; oda:group "Group of parameters" ; oda:description "first"
param_2 = '' # http://odahub.io/ontology#String ; oda:label "Second" ; oda:group "Group of parameters" ; oda:description "second"
param_3 = '' # http://odahub.io/ontology#String ; oda:label "Third" ; oda:group "Group of parameters" ; oda:description "third"
```

Which, over the Mmoda interface, will result in the layout displayed in the image below:

![image](grouped_params.png)

### How to upload a file to be used for the notebook execution

In order to define a file as one of the input notebook parameters, two possible annotations (from the MMODA [ontology](https://odahub.io/ontology/)) are available:
Expand Down

0 comments on commit 2d19f90

Please sign in to comment.