Importing Tools and Data

The Saturn UI provides interfaces for importing tools (e.g., WDL-based workflows) and data (e.g., samples and metadata) into a project. The purpose of these interfaces is to allow tool and data repositories to allow exporting into this system without having to build a UI flow for doing so. Instead, each repository can simply re-use the UI created explicitly for this purpose within the Saturn UI.

Importing a Tool

Once a user has selected a tool from your repository, direct the user to a URL of this form:

https://bvdp-saturn-prod.appspot.com/#import-tool/[type]/[location]/[organization]/[namespace]/[name]:[version]

Example:

https://bvdp-saturn-prod.appspot.com/#import-tool/dockstore/github.com/DataBiosphere/topmed-workflows/Functional_Equivalence:1.7.0

Importing Data

The system can currently import samples and participants if contained within a zip-compressed very specific variant of BDBag. The import will include data from files named participants.tsv and/or samples.tsv contained within the directory structure.

Once a user has selected the data they would like to import, direct the user to a URL of this form:

https://bvdp-saturn-prod.appspot.com/#import-data?url=[url]

Example:

https://bvdp-saturn-prod.appspot.com/#import-data?url=https%3A%2F%2Fgithub.com%2Fbroadinstitute%2Ffirecloud-orchestration%2Fblob%2Fdevelop%2Fsrc%2Ftest%2Fresources%2Ftestfiles%2Fbagit%2Ftestbag.zip%3Fraw%3Dtrue