-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reorganize docs on running the pipeline. (#610)
* Reorganize docs on running the pipeline. * Update page descriptions. * Revert all cost-related updates * Fix quick start link. * Reorganize & improve run/overview & fix broken links. * Add a note on supporting GCP only.
- Loading branch information
Showing
13 changed files
with
122 additions
and
85 deletions.
There are no files selected for viewing
4 changes: 2 additions & 2 deletions
4
website/docs/execmodes/_category_.json → ...docs/advanced/development/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
title: Cromwell | ||
description: Running GATK-SV on Cromwell | ||
sidebar_position: 0 | ||
--- | ||
|
||
# Cromwell | ||
|
||
[Cromwell](https://github.com/broadinstitute/cromwell) is a workflow management system | ||
that takes a workflow (e.g., a workflow written in [Workflow Description Language (WDL)](https://openwdl.org)), | ||
its dependencies and input data, and runs it on a given platform | ||
(e.g., [GCP](https://cromwell.readthedocs.io/en/stable/backends/Google/)). | ||
In order to run a workflow on Cromwell, you need a running instance of | ||
Cromwell that is available in two forms: [Server and stand-alone mode](https://cromwell.readthedocs.io/en/stable/Modes/). | ||
|
||
In general, you may use a managed Cromwell server maintained by your | ||
institute or host a self-managed server, or run Cromwell as a standalone Java application. | ||
The former is ideal for large scale execution in a managed environment, | ||
and the latter is useful for small scale and isolated WDL development. | ||
|
||
:::info | ||
Due to its dependency on cloud-hosted resources and large-scale execution needs, | ||
we currently do not support running the entire GATK-SV pipeline using | ||
Cromwell as a [stand-alone Java application](https://cromwell.readthedocs.io/en/stable/Modes/#run). | ||
|
||
Additionally, we currently only support running the pipeline on | ||
Google Cloud Platform (GCP). | ||
::: | ||
|
||
# Cromwell Server | ||
|
||
There are two option to communicate with a running Cromwell server: | ||
[REST API](https://cromwell.readthedocs.io/en/stable/tutorials/ServerMode/), and | ||
[Cromshell](https://github.com/broadinstitute/cromshell) which is a command line tool | ||
to interface with a Cromwell server. We recommend using Cromshell due to its simplicity | ||
of use. This documentation is explained using Cromshell, but the same steps can be | ||
taken using the REST API. | ||
|
||
- **Setup Cromwell**: You may follow [this](https://cromwell.readthedocs.io/en/stable/Modes/) documentation | ||
on setting up a Cromwell server. | ||
|
||
- **Setup Cromshell**: You may follow [this](https://github.com/broadinstitute/cromshell) documentation | ||
on installing and configuring Cromshell to communicate with the Cromwell server. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
title: Overview | ||
description: Overview | ||
sidebar_position: 1 | ||
slug: overview | ||
--- | ||
|
||
There are two factors to consider when deciding how to run GATK-SV. | ||
|
||
|
||
1. **Variant calling modes: single-sample and cohort-based calling.** | ||
GATK-SV offers two distinct pipeline configurations for detecting | ||
structural variations (SVs), each tailored for different research needs: | ||
|
||
- **Single-sample analysis:** | ||
This configuration is ideal for examining SVs in individual samples, | ||
focusing exclusively on data from that single sample. Running this mode is less complex, | ||
involving just one workflow per sample. | ||
|
||
- **Joint calling:** | ||
This configuration is designed for more extensive studies, such as those | ||
involving population genetics or disease association studies. | ||
It analyzes SVs across a cohort by collectively assessing data from all samples. | ||
However, this comes with increased complexity compared to the single-sample mode, | ||
requiring the execution of multiple workflows and involves data preparation steps | ||
(e.g., batching files from the cohort). | ||
|
||
|
||
2. **Which platform you would like to use for running GATK-SV?** | ||
You may run GATK-SV on the following platforms. | ||
|
||
- [Terra.bio](https://terra.bio): A user-friendly cloud-native platform for scalable data analysis. | ||
The primary focus of this documentation is on supporting the execution of GATK-SV within the Terra platform. | ||
|
||
- [Cromwell](https://github.com/broadinstitute/cromwell): | ||
You may run GATK-SV on a self-hosted and managed cromwell instance, which is ideal for | ||
power-users and developers. We provide guidelines for this option in the | ||
[_advanced guides_](/docs/advanced/development/cromwell) section. | ||
|
||
|
||
Your decision regarding the execution modes and platform should be guided by | ||
the objectives of your study, the size of your cohort, data access needs, | ||
and the trade-off between a straightforward interface (Terra) | ||
and more detailed customization options (self-managed Cromwell server). | ||
Please refer to the following documentation on running GATK-SV within the Terra platform. | ||
|
||
- [Single-sample on Terra](single.md); | ||
- [Joint calling on Terra](joint.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: Single-sample | ||
description: Run the pipeline on a single sample | ||
sidebar_position: 3 | ||
slug: single | ||
--- | ||
|
||
:::info | ||
This documentation page is incomplete, and we are actively working on improving it with comprehensive information. | ||
::: | ||
|
||
We have developed a | ||
[Terra workspace](https://app.terra.bio/#workspaces/help-gatk/GATK-Structural-Variants-Single-Sample) | ||
for running GATK-SV on a single sample, which contains the related documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters