This workflow transforms fastq files and other related datasets into
time-based 4D datasets. The results can be viewed in a visualization tool we
are developing, but are also available for other types of analysis and
processing.
The components and data specifications are targeted to run on LANL's EDGE infrastructure. The specifications, repositories and instructions to manage and run this workflow are:
- Input deck specification This is the input deck required by the end-to-end workflow. It defines all input files and metadata needed to create the 4D data for the rest of the workflow.
- EDGE end-to-end workflow This is the NextFlow-based workflow that takes the input deck and transforms it into 4D datasets that can be viewed with an interactive viewer.
- 4D data specification This is the specification for the 4D datasets required by downstream analysis and visualization tools.
- 4D dataset viewer This is the interactive viewer that can browse 4D datasets.
For this version of the workflow tools, all files specified in an epicworkflow.yaml file
are expected to be available on a shared file system accessible by the EDGE instance
running the workflow. Data upload is outside the scope of this workflow.
The user defines an epicworkflow.yaml file, as specified here.
The method of creating this file is outside the scope of this workflow definition.
The user requests the workflow be run on a specific epicworkflow.yaml file.
The repository for the master workflow is
here.
The workflow is responsible for creating a valid 4D dataset as
specified here.
The main steps run by the workflow are:
-
epigenstep. This takes theepicworkflow.yamlfile as input and creates the data hierarchy needed by later tools, including directories and some metadata files required by later steps. This step is managed by theepicsuitepython module, and must be run and completed successfully before any subsequent step. -
structuregenstep. This takes theepicworkflow.yamlfile as input, and does all processing needed to create all structure files required by the 4D data specification. The results of this step are placed at the correct place in the data hierarchy created previously. -
trackgenstep. This takes theepicworkflow.yamlfile as input, and does all processing needed to create all track files required by the 4D data specification. The results of this step are placed at the correct place in the data hierarchy created previously.
Once the workflow steps have run and completed successfully, the visual exploration tool can be run on the resulting 4D ensemble dataset. The tool takes the top level of the resulting data hierarchy as an argument, and allows the user to explore all experiments, chromosomes and tracks that have been created.
-
Each of these steps can be run multiple times on a single
epicworkflow.yamlfile, incrementally adding data to the 4D dataset for that workflow. The steps should be managed such that they only perform operations and create files that are required. In particular, the steps shall not recompute existing results that are valid given the set of inputs. -
Step 1 must be run and successfully completed before any other step is run.
-
Steps 2 and 3 can be run concurrently. They are not dependent upon each other.
-
All
.fastqfiles contain data for the same list of chromosomes. -
All
.fastqfiles contain data for the same resolution. -
All datasets have the same number of timesteps, and those timesteps have the same
timevalues.