Guide to entering Computational Workflow Metadata

This guide is currently being compiled. Some of the information may be updated shortly.

1. Computational workflow metadata
   1. Workflow Type
   2. External Code Repository URL
   3. Documentation

Computational workflow metadata

 

Workflow Type

The kind of computational workflow, which is designed to compose and execute a series of computational or data manipulation steps in a scientific application. (Recommended)

Note: That is a value-list controlled metadata, please see the list below.

Existing values for “Workflow Type”

• Common Workflow Language (CWL)
• Workflow Description Language (WDL)
• Nextflow
• Snakemake
• Ruffus
• DAGMan
• Jupyter Notebook
• R Notebook
• MATLAB Script
• Bash Script
• Makefile
• Other Python-based workflow
• Other R-based workflow
• Other

Example

Jupyter Notebook

 

External Code Repository URL

Absolute URL, beginning with https://, to another public repository where the un-compiled, human-readable code and related code is also located. (Recommended)

Note: The URL entered is currently not clickable.

Click on the (+) button to add an external code repository URL.

Example

https://github.com/etalab/recherche-data-gouv-fr

 

Documentation

Absolute URL, beginning with https://, to the documentation or text describing the computational workflow and its use. (Recommended)

Note: Use HTML tags to make the link clickable.

Click on the (+) button to add a documentation.

Example

<a href="https://github.com/etalab/recherche-data-gouv-fr/blob/master/README.md">https://github.com/etalab/recherche-data-gouv-fr/blob/master/README.md</a>