Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extra metadata doc #114

Merged
merged 5 commits into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading