annotate gatk2_wrapper.py @ 6:35c00763cb5c draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
author iuc
date Mon, 04 Jun 2018 05:38:15 -0400
parents f244b8209eb8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
1 #!/usr/bin/env python
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
2 # David Hoover, based on gatk by Dan Blankenberg
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
3 """
340633249b3d Uploaded
bgruening
parents:
diff changeset
4 A wrapper script for running the GenomeAnalysisTK.jar commands.
340633249b3d Uploaded
bgruening
parents:
diff changeset
5 """
340633249b3d Uploaded
bgruening
parents:
diff changeset
6
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
7 import optparse
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
8 import os
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
9 import shutil
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
10 import subprocess
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
11 import sys
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
12 import tempfile
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
13 from binascii import unhexlify
340633249b3d Uploaded
bgruening
parents:
diff changeset
14
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
15 GALAXY_EXT_TO_GATK_EXT = { 'gatk_interval': 'intervals', 'bam_index': 'bam.bai', 'gatk_dbsnp': 'dbSNP', 'picard_interval_list': 'interval_list' } # items not listed here will use the galaxy extension as-is
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
16 GALAXY_EXT_TO_GATK_FILE_TYPE = GALAXY_EXT_TO_GATK_EXT # for now, these are the same, but could be different if needed
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
17 DEFAULT_GATK_PREFIX = "gatk_file"
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
18 CHUNK_SIZE = 2**20 # 1mb
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
19
340633249b3d Uploaded
bgruening
parents:
diff changeset
20
340633249b3d Uploaded
bgruening
parents:
diff changeset
21 def cleanup_before_exit( tmp_dir ):
340633249b3d Uploaded
bgruening
parents:
diff changeset
22 if tmp_dir and os.path.exists( tmp_dir ):
340633249b3d Uploaded
bgruening
parents:
diff changeset
23 shutil.rmtree( tmp_dir )
340633249b3d Uploaded
bgruening
parents:
diff changeset
24
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
25
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
26 def gatk_filename_from_galaxy( galaxy_filename, galaxy_ext, target_dir=None, prefix=None ):
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
27 suffix = GALAXY_EXT_TO_GATK_EXT.get( galaxy_ext, galaxy_ext )
340633249b3d Uploaded
bgruening
parents:
diff changeset
28 if prefix is None:
340633249b3d Uploaded
bgruening
parents:
diff changeset
29 prefix = DEFAULT_GATK_PREFIX
340633249b3d Uploaded
bgruening
parents:
diff changeset
30 if target_dir is None:
340633249b3d Uploaded
bgruening
parents:
diff changeset
31 target_dir = os.getcwd()
340633249b3d Uploaded
bgruening
parents:
diff changeset
32 gatk_filename = os.path.join( target_dir, "%s.%s" % ( prefix, suffix ) )
340633249b3d Uploaded
bgruening
parents:
diff changeset
33 os.symlink( galaxy_filename, gatk_filename )
340633249b3d Uploaded
bgruening
parents:
diff changeset
34 return gatk_filename
340633249b3d Uploaded
bgruening
parents:
diff changeset
35
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
36
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
37 def gatk_filetype_argument_substitution( argument, galaxy_ext ):
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
38 return argument % dict( file_type=GALAXY_EXT_TO_GATK_FILE_TYPE.get( galaxy_ext, galaxy_ext ) )
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
39
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
40
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
41 def open_file_from_option( filename, mode='rb' ):
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
42 if filename:
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
43 return open( filename, mode=mode )
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
44 return None
340633249b3d Uploaded
bgruening
parents:
diff changeset
45
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
46
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
47 def html_report_from_directory( html_out, dir ):
340633249b3d Uploaded
bgruening
parents:
diff changeset
48 html_out.write( '<html>\n<head>\n<title>Galaxy - GATK Output</title>\n</head>\n<body>\n<p/>\n<ul>\n' )
340633249b3d Uploaded
bgruening
parents:
diff changeset
49 for fname in sorted( os.listdir( dir ) ):
340633249b3d Uploaded
bgruening
parents:
diff changeset
50 html_out.write( '<li><a href="%s">%s</a></li>\n' % ( fname, fname ) )
340633249b3d Uploaded
bgruening
parents:
diff changeset
51 html_out.write( '</ul>\n</body>\n</html>\n' )
340633249b3d Uploaded
bgruening
parents:
diff changeset
52
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
53
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
54 def index_bam_files( bam_filenames ):
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
55 for bam_filename in bam_filenames:
340633249b3d Uploaded
bgruening
parents:
diff changeset
56 bam_index_filename = "%s.bai" % bam_filename
340633249b3d Uploaded
bgruening
parents:
diff changeset
57 if not os.path.exists( bam_index_filename ):
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
58 # need to index this bam file
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
59 stderr_name = tempfile.NamedTemporaryFile( prefix="bam_index_stderr" ).name
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
60 command = 'samtools index %s %s' % ( bam_filename, bam_index_filename )
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
61 try:
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
62 subprocess.check_call( args=command, shell=True, stderr=open( stderr_name, 'wb' ) )
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
63 except:
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
64 for line in open( stderr_name ):
340633249b3d Uploaded
bgruening
parents:
diff changeset
65 print >> sys.stderr, line
340633249b3d Uploaded
bgruening
parents:
diff changeset
66 raise Exception( "Error indexing BAM file" )
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
67 finally:
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
68 os.unlink( stderr_name )
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
69
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
70
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
71 def __main__():
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
72 # Parse Command Line
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
73 parser = optparse.OptionParser()
340633249b3d Uploaded
bgruening
parents:
diff changeset
74 parser.add_option( '-p', '--pass_through', dest='pass_through_options', action='append', type="string", help='These options are passed through directly to GATK, without any modification.' )
340633249b3d Uploaded
bgruening
parents:
diff changeset
75 parser.add_option( '-o', '--pass_through_options', dest='pass_through_options_encoded', action='append', type="string", help='These options are passed through directly to GATK, with decoding from binascii.unhexlify.' )
340633249b3d Uploaded
bgruening
parents:
diff changeset
76 parser.add_option( '-d', '--dataset', dest='datasets', action='append', type="string", nargs=4, help='"-argument" "original_filename" "galaxy_filetype" "name_prefix"' )
340633249b3d Uploaded
bgruening
parents:
diff changeset
77 parser.add_option( '', '--max_jvm_heap', dest='max_jvm_heap', action='store', type="string", default=None, help='If specified, the maximum java virtual machine heap size will be set to the provide value.' )
340633249b3d Uploaded
bgruening
parents:
diff changeset
78 parser.add_option( '', '--max_jvm_heap_fraction', dest='max_jvm_heap_fraction', action='store', type="int", default=None, help='If specified, the maximum java virtual machine heap size will be set to the provide value as a fraction of total physical memory.' )
340633249b3d Uploaded
bgruening
parents:
diff changeset
79 parser.add_option( '', '--stdout', dest='stdout', action='store', type="string", default=None, help='If specified, the output of stdout will be written to this file.' )
340633249b3d Uploaded
bgruening
parents:
diff changeset
80 parser.add_option( '', '--stderr', dest='stderr', action='store', type="string", default=None, help='If specified, the output of stderr will be written to this file.' )
340633249b3d Uploaded
bgruening
parents:
diff changeset
81 parser.add_option( '', '--html_report_from_directory', dest='html_report_from_directory', action='append', type="string", nargs=2, help='"Target HTML File" "Directory"')
340633249b3d Uploaded
bgruening
parents:
diff changeset
82 parser.add_option( '-e', '--phone_home', dest='phone_home', action='store', type="string", default='STANDARD', help='What kind of GATK run report should we generate(NO_ET|STANDARD|STDOUT)' )
340633249b3d Uploaded
bgruening
parents:
diff changeset
83 parser.add_option( '-K', '--gatk_key', dest='gatk_key', action='store', type="string", default=None, help='What kind of GATK run report should we generate(NO_ET|STANDARD|STDOUT)' )
340633249b3d Uploaded
bgruening
parents:
diff changeset
84 (options, args) = parser.parse_args()
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
85
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
86 if options.pass_through_options:
340633249b3d Uploaded
bgruening
parents:
diff changeset
87 cmd = ' '.join( options.pass_through_options )
340633249b3d Uploaded
bgruening
parents:
diff changeset
88 else:
340633249b3d Uploaded
bgruening
parents:
diff changeset
89 cmd = ''
340633249b3d Uploaded
bgruening
parents:
diff changeset
90 if options.pass_through_options_encoded:
340633249b3d Uploaded
bgruening
parents:
diff changeset
91 cmd = '%s %s' % ( cmd, ' '.join( map( unhexlify, options.pass_through_options_encoded ) ) )
340633249b3d Uploaded
bgruening
parents:
diff changeset
92 if options.max_jvm_heap is not None:
340633249b3d Uploaded
bgruening
parents:
diff changeset
93 cmd = cmd.replace( 'java ', 'java -Xmx%s ' % ( options.max_jvm_heap ), 1 )
340633249b3d Uploaded
bgruening
parents:
diff changeset
94 elif options.max_jvm_heap_fraction is not None:
340633249b3d Uploaded
bgruening
parents:
diff changeset
95 cmd = cmd.replace( 'java ', 'java -XX:DefaultMaxRAMFraction=%s -XX:+UseParallelGC ' % ( options.max_jvm_heap_fraction ), 1 )
340633249b3d Uploaded
bgruening
parents:
diff changeset
96 bam_filenames = []
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
97 tmp_dir = tempfile.mkdtemp( prefix='tmp-gatk-' )
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
98 try:
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
99 if options.datasets:
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
100 for ( dataset_arg, filename, galaxy_ext, prefix ) in options.datasets:
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
101 gatk_filename = gatk_filename_from_galaxy( filename, galaxy_ext, target_dir=tmp_dir, prefix=prefix )
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
102 if dataset_arg:
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
103 cmd = '%s %s "%s"' % ( cmd, gatk_filetype_argument_substitution( dataset_arg, galaxy_ext ), gatk_filename )
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
104 if galaxy_ext == "bam":
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
105 bam_filenames.append( gatk_filename )
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
106 if galaxy_ext == 'fasta':
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
107 subprocess.check_call( 'samtools faidx "%s"' % gatk_filename, shell=True )
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
108 subprocess.check_call( 'java -jar %s R=%s O=%s QUIET=true' % ( os.path.join(os.environ['JAVA_JAR_PATH'], 'CreateSequenceDictionary.jar'), gatk_filename, os.path.splitext(gatk_filename)[0] + '.dict' ), shell=True )
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
109 index_bam_files( bam_filenames )
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
110 # set up stdout and stderr output options
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
111 stdout = open_file_from_option( options.stdout, mode='wb' )
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
112 stderr = open_file_from_option( options.stderr, mode='wb' )
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
113 # if no stderr file is specified, we'll use our own
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
114 if stderr is None:
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
115 stderr = tempfile.NamedTemporaryFile( prefix="gatk-stderr-", dir=tmp_dir )
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
116
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
117 proc = subprocess.Popen( args=cmd, stdout=stdout, stderr=stderr, shell=True, cwd=tmp_dir )
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
118 return_code = proc.wait()
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
119
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
120 if return_code:
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
121 stderr_target = sys.stderr
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
122 else:
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
123 stderr_target = sys.stdout
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
124 stderr.flush()
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
125 stderr.seek(0)
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
126 while True:
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
127 chunk = stderr.read( CHUNK_SIZE )
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
128 if chunk:
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
129 stderr_target.write( chunk )
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
130 else:
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
131 break
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
132 stderr.close()
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
133 finally:
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
134 cleanup_before_exit( tmp_dir )
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
135
6
35c00763cb5c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gatk2 commit cf399638ebca4250bcc15f468238a9964de97b33
iuc
parents: 4
diff changeset
136 # generate html reports
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
137 if options.html_report_from_directory:
340633249b3d Uploaded
bgruening
parents:
diff changeset
138 for ( html_filename, html_dir ) in options.html_report_from_directory:
340633249b3d Uploaded
bgruening
parents:
diff changeset
139 html_report_from_directory( open( html_filename, 'wb' ), html_dir )
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
140
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
141
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
142 if __name__ == "__main__":
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
143 __main__()