Linking visualisations in ORDA to data
Web-based visualisations can be included in the visualisation showcase on ORDA by following the instructions below.
Preparation
You will first need to prepare a small metadata visualisation.yaml file describing your visualisation.
Create this via a web form
or manually.
Then follow these instructions if your data is in ORDA, or these if it is in another repository or website.
If you would like to include shiny apps in the showcase, please also read this public guidance/policy statement for hosting shiny apps.
If you are looking for data visualisation tutorials and guidance, visit Dataviz.Shef.
My data has been uploaded and published in ORDA
The following steps will help you link a visualisation to an existing ORDA item by uploading the YAML file and/or the visualisation image file into the item you have already published on ORDA.
1. Open
'My Data'
in your ORDA account.
2. Select the appropriate dataset and open the ORDA record editing interface by clicking on the pencil icon to the right of the item in the 'My data' list.
3. In the record editing interface, drag and drop, or browse and select the visualisation.yaml file and the visualisation image file, to upload them into the item record.
4. Add 'visualisation' to the keyword metadata field.
5. Check the 'Publish' tickbox and click on 'Save'.
6. An administrator will get a notification that an edited record needs approval for publishing and the administrator will check the metadata
in the visualisation.yaml file.
My data has NOT been uploaded to ORDA
To include your visualisations in the showcase you will need to create a new item in ORDA, upload the YAML file and/or the visualisation image file to it and either upload or link to the data.
1. Click 'Upload'
on the navigation bar and open 'My data' in your ORDA account.
2. Create a new record by doing one of the following:
• Upload the visualisation.yaml file and the visualisation image file to the 'My data' interface, by drag and drop or browse and select.
• Clicking on '+ Create a new item' and In the record editing interface, drag and drop, or browse and select the visualisation.yaml file and the visualisation image file, to upload them into the item record.
3. Complete the mandatory metadata fields - giving the record an appropriate title, author names, categories (subjects), keywords and description. Ensure that the word 'visualisation' is added to the keyword metadata field.
4. Add a link (preferably a DOI) to the dataset into the 'references' field, where the dataset is available from an external repository, or drag and drop, or browse and select the data, to upload them into the item record.
5. Check the 'Publish' tickbox and click on 'Publish item', then 'Yes, publish'.
6. An administrator will get a notification that a new record needs approval for publishing and the administrator will check the metadata in the visualisation.yaml file.