Workflow Build Process
Last updated
Was this helpful?
Last updated
Was this helpful?
You can create workflows using the or using the CLI using tools provided by the . This page focuses on creating a workflow in a terminal. It will walk you through important features of the DNAnexus workflow build infrastructure that will help you build your workflows programmatically.
For information on building Nextflow workflows, see .
DNAnexus workflows can be built using the command, which takes the workflow JSON representation from your local workstation and uploads it to a on the Platform. The DNAnexus SDK expects the workflow definition to reside in a directory with the following structure:
The file dxworkflow.json
is a DNAnexus workflow metadata file. If it is detected in the directory provided to dx build
, the dx-toolkit will attempt to build a workflow on the Platform by passing the workflow specification in dxworkflow.json
to .
The Readme.md
file, if present, is inlined into the description
field of the workflow.
Having placed the workflow metadata in MyWorkflow
, you can load your workflow on the DNAnexus Platform:
This will create a directory MyWorkflow
(after the workflow's name) containing the workflow representation in the working directory. It can be used again to create a new workflow with dx build
.
The built workflow will be in a , immutable state. Adding --keep-open
option will keep the workflow open allowing you to edit the workflow from the DNAnexus UI.
Similarly to apps and applets, developers can use the command to download the workflow description from the Platform, for example: