Skip to content

Commit

Permalink
Added WDLs for a GATK tutorial and a readme for the GATK folder
Browse files Browse the repository at this point in the history
	Add WDL scripts and JSON examples for GATK Tutorial#8017
	Add two more tutorial WDLs and modify tutorial_8017.wdl
	Add README.md file for gatk folder
  • Loading branch information
shlee authored and geoffjentry committed Oct 12, 2017
1 parent f88b304 commit 10e12d9
Show file tree
Hide file tree
Showing 8 changed files with 926 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ tags
.idea/
target
.artifactory
*~
.DS_Store

34 changes: 34 additions & 0 deletions scripts/tutorials/gatk/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
README.md for wdl/scripts/tutorials/gatk/

This folder contains WDL scripts for workflows outlined in GATK website tutorials.

## Easily find information on each tutorial
The WDL scripts within this `gatk` folder come from tutorials from the [GATK Tutorials](https://software.broadinstitute.org/gatk/documentation/topic?name=tutorials) website. Numbers in the file names correspond to website article numbers. For example, for `tutorial_8017.wdl` you can plug in `8017` into the following URL to view the corresponding tutorial description. Use the base URL for each website as shown below.

- **GATK website URL**: https://software.broadinstitute.org/gatk/documentation/article?id=8017

## Download example data
The tutorials come with example data that you can use with the scripts. Find the links to download example data on respective tutorial webpages. Alternatively, you may download the example data from either the FTP site or our shared Google Drive folder. Example data bundle names also include the website article number.

- **FTP site**: `ftp://[email protected]/tutorials/datasets`. Copy and paste the ftp address into a web browser. Leave the password field blank.
- **GoogleDrive folder**: [https://drive.google.com/open?id=0B3LMJn1Ee-xofnhyNF92cFY2bzJaMDMwZUF2amstcDdWNVpEenoxSGxiWGJkd1o2S1JNTXM](https://drive.google.com/open?id=0BzI1CyccGsZibnRtQjhaakxobEE).

## Be sure to fill in the JSON for your setup
If a WDL script comes with a matching example JSON file and you choose to use this file, then be sure to modify the directory paths to files for your own setup. Otherwise, generate a blank JSON file with the following command, then fill in the details.

java -jar wdltool.jar inputs file.wdl > file.json

The example JSON file can show you how to list files that are in array format.

## Information on setting up Cromwell to run WDL scripts
- See [WDL Article#6671](https://software.broadinstitute.org/wdl/guide/article?id=6671) for Cromwell setup options.
- See [GATK Blog#7349](https://software.broadinstitute.org/gatk/blog?id=7349) for an introduction to Cromwell and WDL.
- For details on interpreting and writing WDL scripts, see the [QuickStart guide](https://software.broadinstitute.org/wdl/userguide/index).

If you modify a WDL script, be sure it passes validation with the following command.

java -jar wdltool.jar validate file.wdl

Finally, run a script with inputs using this command:

java -jar cromwell.jar run file.wdl file.json
23 changes: 23 additions & 0 deletions scripts/tutorials/gatk/tutorial_8017.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"Tutorial_8017.final_vcf_name": "/Users/shlee/Desktop/tutorial_8017/multisample",
"Tutorial_8017.fastq_directory_path": "/Users/shlee/Desktop/tutorial_8017/",
"Tutorial_8017.ref_alt": "/Users/shlee/Desktop/tutorial_8017/hg38_mini_ref/chr19_chr19_KI270866v1_alt.fasta.alt",
"Tutorial_8017.ref_amb": "/Users/shlee/Desktop/tutorial_8017/hg38_mini_ref/chr19_chr19_KI270866v1_alt.fasta.amb",
"Tutorial_8017.ref_ann": "/Users/shlee/Desktop/tutorial_8017/hg38_mini_ref/chr19_chr19_KI270866v1_alt.fasta.ann",
"Tutorial_8017.ref_bwt": "/Users/shlee/Desktop/tutorial_8017/hg38_mini_ref/chr19_chr19_KI270866v1_alt.fasta.bwt",
"Tutorial_8017.ref_pac": "/Users/shlee/Desktop/tutorial_8017/hg38_mini_ref/chr19_chr19_KI270866v1_alt.fasta.pac",
"Tutorial_8017.ref_sa": "/Users/shlee/Desktop/tutorial_8017/hg38_mini_ref/chr19_chr19_KI270866v1_alt.fasta.sa",
"Tutorial_8017.ref_dict": "/Users/shlee/Desktop/tutorial_8017/hg38_mini_ref/chr19_chr19_KI270866v1_alt.dict",
"Tutorial_8017.input_FASTQ": [
["/Users/shlee/Desktop/tutorial_8017/altalt.read1.fq" , "/Users/shlee/Desktop/tutorial_8017/altalt.read2.fq"],
["/Users/shlee/Desktop/tutorial_8017/paalt.read1.fq" , "/Users/shlee/Desktop/tutorial_8017/paalt.read2.fq"],
["/Users/shlee/Desktop/tutorial_8017/papa.read1.fq" , "/Users/shlee/Desktop/tutorial_8017/papa.read2.fq"]
],
"Tutorial_8017.ref_fasta": "/Users/shlee/Desktop/tutorial_8017/hg38_mini_ref/chr19_chr19_KI270866v1_alt.fasta",
"Tutorial_8017.PICARD": "/Applications/genomicstools/picard/picard-tools-2.5.0/picard.jar",
"Tutorial_8017.ref_index": "/Users/shlee/Desktop/tutorial_8017/hg38_mini_ref/chr19_chr19_KI270866v1_alt.fasta.fai",
"Tutorial_8017.BWA0715": "/Applications/genomicstools/bwa/bwa-0.7.15/bwa",
"Tutorial_8017.GATK": "/Applications/genomicstools/gatk/GenomeAnalysisTK-3.6/GenomeAnalysisTK.jar",
"Tutorial_8017.min_unclipped_bases": "32",
"Tutorial_8017.unmap_contaminant_reads": "false"
}
Loading

0 comments on commit 10e12d9

Please sign in to comment.