diff --git a/README.md b/README.md index ae1e2d2..1965fe5 100644 --- a/README.md +++ b/README.md @@ -52,17 +52,24 @@ This optional evaluation and plotting workflow runs a filtering model against tr - Evaluation summary - Plots +### Software version notes : +- GATK 4.1 +- samtools 1.3.1 +- Cromwell version support + - Successfully tested on v37 + - Does not work on versions < v23 due to output syntax + ### Important Note : -- Runtime parameters are optimized for Broad's Google Cloud Platform implementation. +- The provided JSON is meant to be a ready to use example JSON template of the workflow. It is the user’s responsibility to correctly set the reference and resource input variables using the [GATK Tool and Tutorial Documentations](https://software.broadinstitute.org/gatk/documentation/). +- Relevant reference and resources bundles can be accessed in [Resource Bundle](https://software.broadinstitute.org/gatk/download/bundle). +- Runtime parameters are optimized for Broad's Google Cloud Platform implementation. - For help running workflows on the Google Cloud Platform or locally please view the following tutorial [(How to) Execute Workflows from the gatk-workflows Git Organization](https://software.broadinstitute.org/gatk/documentation/article?id=12521). -- Please post questions to the [GATK forum](https://gatkforums.broadinstitute.org/gatk/categories/ask-the-team). -- Please visit our [User Guide](https://software.broadinstitute.org/gatk/documentation/) site for further documentation on workflows and tools. +- The following material is provided by the GATK Team. Please post any questions or concerns to one of our forum sites : [GATK](https://gatkforums.broadinstitute.org/gatk/categories/ask-the-team/) , [FireCloud](https://gatkforums.broadinstitute.org/firecloud/categories/ask-the-firecloud-team) or [Terra](https://broadinstitute.zendesk.com/hc/en-us/community/topics/360000500432-General-Discussion) , [WDL/Cromwell](https://gatkforums.broadinstitute.org/wdl/categories/ask-the-wdl-team). +- Please visit the [User Guide](https://software.broadinstitute.org/gatk/documentation/) site for further documentation on our workflows and tools. ### LICENSING : This script is released under the WDL source code license (BSD-3) (see LICENSE in https://github.com/broadinstitute/wdl). Note however that the programs it calls may be subject to different licenses. Users are responsible for checking that they are - authorized to run all programs before running this script. Please see the docker - page at https://hub.docker.com/r/broadinstitute/genomes-in-the-cloud/ for detailed - licensing information pertaining to the included programs. + authorized to run all programs before running this script. diff --git a/cram2filtered.inputs.json b/cram2filtered.inputs.json index 05ac802..02b48b5 100644 --- a/cram2filtered.inputs.json +++ b/cram2filtered.inputs.json @@ -22,7 +22,7 @@ "Cram2FilteredVcf.transfer_batch_size": 32, "##_COMMENT4": "Runtime Attributes", - "Cram2FilteredVcf.gatk_docker": "broadinstitute/gatk", + "Cram2FilteredVcf.gatk_docker": "broadinstitute/gatk:4.1.0.0", "Cram2FilteredVcf.preemptible_attempts": 10, "Cram2FilteredVcf.mem_gb": 7 } diff --git a/cram2filtered.wdl b/cram2filtered.wdl index 03cf107..1f41d9a 100644 --- a/cram2filtered.wdl +++ b/cram2filtered.wdl @@ -10,7 +10,7 @@ # (https://github.com/gatk-workflows/gatk4-data-processing/blob/master/processing-for-variant-discovery-gatk4.wdl) # Also accepts a BAM as the input file in which case a BAM index is required as well. -import "cnn_variant_common_tasks.wdl" as CNNTasks +import "https://raw.githubusercontent.com/gatk-workflows/gatk4-cnn-variant-filter/1.1.0/tasks/cnn_variant_common_tasks.wdl" as CNNTasks workflow Cram2FilteredVcf { File input_file # Aligned CRAM file or Aligned BAM files diff --git a/cram2model.wdl b/cram2model.wdl index 4b7f000..f203263 100644 --- a/cram2model.wdl +++ b/cram2model.wdl @@ -1,6 +1,6 @@ # CRAM to trained CNNVariant Model -import "cnn_variant_common_tasks.wdl" as CNNTasks +import "https://raw.githubusercontent.com/gatk-workflows/gatk4-cnn-variant-filter/1.1.0/tasks/cnn_variant_common_tasks.wdl" as CNNTasks workflow Cram2TrainedModel { File input_cram diff --git a/cnn_variant_common_tasks.wdl b/tasks/cnn_variant_common_tasks.wdl similarity index 100% rename from cnn_variant_common_tasks.wdl rename to tasks/cnn_variant_common_tasks.wdl