You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- refactor: Update all workflows, tasks, and subworkflows for sprocket compatibility
- reformat meta and parameter_meta
- symlink most inputs into working directory
- quote most filenames
- bump: update HiPhase to 1.6.0
- bump: update pbmm2 to 26.1.0
- bump: update pb-StarPhase to 2.0.1
- bump: update Mitorsaw to 0.2.7
- bump: update Paraphase to 3.5.0
- bump: update MethBat to 0.17.0
- bump: update DeepVariant to 1.10.0
- refactor: rename Boolean gpu to Boolean use_gpu for clarity
- feature: add option Boolean use_parabricks_deepvariant to use Parabricks 4.7.0-1 DeepVariant for small variant calling (equivalent to DeepVariant 1.9.0)
- docs: add documentation for Parabricks DeepVariant
- refactor: increase resource allocation for tasks that are not IO-bound
- refactor: remove GitHub Actions
- refactor: removing wdl-common submodule to reduce complexity
Copy file name to clipboardExpand all lines: README.md
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,11 @@ Workflow for analyzing human PacBio whole genome sequencing (WGS) data using [Wo
9
9
10
10
## Workflow
11
11
12
-
Starting in v2, this repo contains two related workflows. The `singleton` workflow is designed to analyze a single sample, while the `family` workflow is designed to analyze a family of related samples. With the exception of the joint calling tasks in the `family` workflow, both workflows make use of the same tasks, although the input and output structure differ.
12
+
Starting in v2, this repo contains two related workflows. The `singleton` workflow is designed to analyze a single sample, while the `family` workflow is designed to analyze a family of related samples. With the exception of the joint calling tasks in the `family` workflow, both workflows make use of the same tasks, although the input and output structure differ.
13
13
14
-
The `family` workflow will be best for most use cases. The `singleton` workflow inputs and output structures are relatively flat, which should improve compatibility with platforms like Terra.
14
+
The `family` workflow will be best for most use cases. The `singleton` workflow inputs and output structures are relatively flat, which should improve compatibility with platforms like Terra.
15
15
16
-
Both workflows are designed to analyze human PacBio whole genome sequencing (WGS) data. The workflows are designed to be run on Azure, AWS HealthOmics, GCP, or HPC backends.
16
+
Both workflows are designed to analyze human PacBio whole genome sequencing (WGS) data. The workflows are designed to be run on Azure, AWS HealthOmics, GCP, or HPC backends.
17
17
18
18
**Workflow entrypoint**:
19
19
@@ -24,27 +24,26 @@ Both workflows are designed to analyze human PacBio whole genome sequencing (WGS
24
24
25
25
This is an actively developed workflow with multiple versioned releases, and we make use of git submodules for common tasks that are shared by multiple workflows. There are two ways to ensure you are using a supported release of the workflow and ensure that the submodules are correctly initialized:
26
26
27
-
1) Download the release zips directly from a [supported release](https://github.com/PacificBiosciences/HiFi-human-WGS-WDL/releases/tag/v3.2.1):
27
+
1) Download the release zips directly from a [supported release](https://github.com/PacificBiosciences/HiFi-human-WGS-WDL/releases/tag/v3.3.0):
The most resource-heavy step in the workflow requires 64 cpu cores and 256 GB of RAM. Ensure that the backend environment you're using has enough quota to run the workflow.
46
45
47
-
On some backends, you may be able to make use of a GPU to accelerate the DeepVariant step.The GPU is not required, but it can significantly speed up the workflow. If you have access to a GPU, you can set the `gpu` parameter to `true` in the inputs JSON file.
46
+
On some backends, you may be able to make use of a GPU to accelerate the DeepVariant step.The GPU is not required, but it can significantly speed up the workflow. If you have access to a GPU, you can set the `gpu` parameter to `true` in the inputs JSON file.
48
47
49
48
## Reference datasets and associated workflow files
50
49
@@ -96,7 +95,7 @@ The input to a workflow run is defined in JSON format. Template input files with
96
95
97
96
Using the appropriate inputs template file, fill in the cohort and sample information (see [Workflow Inputs](#workflow-inputs) for more information on the input structure).
98
97
99
-
If using an HPC backend, you will need to download the reference bundle and replace the `<local_path_prefix>` in the input template file with the local path to the reference datasets on your HPC. If using Amazon HealthOmics, you will need to download the reference bundle, upload it to your S3 bucket, and adjust paths accordingly.
98
+
If using an HPC backend, you will need to download the reference bundle and replace the `<local_path_prefix>` in the input template file with the local path to the reference datasets on your HPC. If using Amazon HealthOmics, you will need to download the reference bundle, upload it to your S3 bucket, and adjust paths accordingly.
0 commit comments