This repository holds WDL workflows and Docker build scripts for production workflows used by the Human Pangenome Project.
All WDLs and containers created in this repository are licensed under the MIT license. The underlying tools (that the WDLs and containers run) are likely covered under one or more Free and Open Source Software licenses, but we cannot make any guarantees to that fact.
The repo is split into assembly and QC workflows with the following organization:
── docker/
└── toolName/
└── Dockerfile
└── Makefile
└── scripts/
└── toolName/
└── scriptName.py
── wdl/
└── tasks/
│ └── taskName.wdl
└── workflows/
└── workFlowName.wdl
Assemblies are produced with Hifiasm from reads filtered with HiFiAdapterFilt:
- Filter HiFi Data w/ HiFiAdapterFilt
- Run Hifiasm
Assembly QC is run with one of two workflows:
- standard_qc.wdl
- standard_qc_no_qv.wdl (for samples with no child Illumina data)
The following tools are included:
In addition to the automated QC of assemblies, the following tasks are included:
- read_stats.wdl: outputs read length statistics for bam/fastq files
- mask_assembly.wdl: masks assemblies in regions found in bed file
- dropFastaContigs.wdl: drops contigs from assemblies based on text file list of contigs to drop
- contamination.wdl: detects contamination in assemblies
The contamination workflow is modeled after an NCBI document describing methods for detection and flagging of common contaminants in assemblies.
The workflow takes as input an assembly and contamination reference sequences to be used in the following subtasks. Each subtask is optional and is enabled by providing the reference sequence.
- Eukaryotic Contamination: cloning artifacts that are likely to show up as contaminants across all eukaryotic species: vector sequences, E.coli genome, phage genomes, bacterial Insertion Sequences and transposons here
- Mitochondria: mitochondrial sequences end in genomic.fna.gz here
- Plastids: plastid sequences end in genomic.fna.gz here
- Vecscreen: sequencing adaptor screens here
- RRNA: ribosomal RNA here
- RefSeq: reference sequences from other species organized here ending in genomic.fna.gz. Large files may need to be split into smaller shards.
The output includes the direct output from each subtask, BED files summarizing all the genomic locations where contamination was found, and a file detailing the ratio of contamination sequence per assembly contig.