annotate data_manager/picard_index_builder.py @ 3:ae080ff506fd draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
author iuc
date Mon, 03 Feb 2020 17:27:33 -0500
parents b99040168706
children e1a567161eab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
1 #!/usr/bin/env python
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
2 # Dan Blankenberg
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
3 from __future__ import print_function
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
4
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
5 import optparse
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
6 import os
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
7 import subprocess
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
8 import sys
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
9 from json import dumps, loads
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
10
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
11 DEFAULT_DATA_TABLE_NAME = "picard_indexes"
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
12
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
13
3
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
14 def get_id_name(params, dbkey, fasta_description=None):
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
15 # TODO: ensure sequence_id is unique and does not already appear in location file
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
16 sequence_id = params['param_dict']['sequence_id']
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
17 if not sequence_id:
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
18 sequence_id = dbkey
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
19
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
20 sequence_name = params['param_dict']['sequence_name']
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
21 if not sequence_name:
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
22 sequence_name = fasta_description
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
23 if not sequence_name:
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
24 sequence_name = dbkey
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
25 return sequence_id, sequence_name
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
26
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
27
3
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
28 def build_picard_index(data_manager_dict, fasta_filename, params, target_directory, dbkey, sequence_id, sequence_name, data_table_name=DEFAULT_DATA_TABLE_NAME):
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
29 # TODO: allow multiple FASTA input files
3
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
30 fasta_base_name = os.path.split(fasta_filename)[-1]
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
31 prefix = os.path.splitext(fasta_base_name)[0]
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
32 sym_linked_fasta_filename = os.path.join(target_directory, fasta_base_name)
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
33 os.symlink(fasta_filename, sym_linked_fasta_filename)
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
34 args = ['picard', 'CreateSequenceDictionary', 'R=%s' % sym_linked_fasta_filename, 'O=%s.dict' % prefix]
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
35 proc = subprocess.Popen(args=args, shell=False, cwd=target_directory)
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
36 return_code = proc.wait()
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
37 if return_code:
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
38 print("Error building index.", file=sys.stderr)
3
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
39 sys.exit(return_code)
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
40 data_table_entry = dict(value=sequence_id, dbkey=dbkey, name=sequence_name, path=fasta_base_name)
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
41 _add_data_table_entry(data_manager_dict, data_table_name, data_table_entry)
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
42
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
43
3
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
44 def _add_data_table_entry(data_manager_dict, data_table_name, data_table_entry):
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
45 data_manager_dict['data_tables'] = data_manager_dict.get('data_tables', {})
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
46 data_manager_dict['data_tables'][data_table_name] = data_manager_dict['data_tables'].get(data_table_name, [])
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
47 data_manager_dict['data_tables'][data_table_name].append(data_table_entry)
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
48 return data_manager_dict
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
49
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
50
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
51 def main():
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
52 parser = optparse.OptionParser()
3
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
53 parser.add_option('-f', '--fasta_filename', dest='fasta_filename', action='store', type="string", default=None, help='fasta_filename')
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
54 parser.add_option('-d', '--fasta_dbkey', dest='fasta_dbkey', action='store', type="string", default=None, help='fasta_dbkey')
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
55 parser.add_option('-t', '--fasta_description', dest='fasta_description', action='store', type="string", default=None, help='fasta_description')
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
56 parser.add_option('-n', '--data_table_name', dest='data_table_name', action='store', type="string", default=None, help='data_table_name')
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
57 (options, args) = parser.parse_args()
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
58
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
59 filename = args[0]
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
60
3
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
61 params = loads(open(filename).read())
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
62 target_directory = params['output_data'][0]['extra_files_path']
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
63 os.mkdir(target_directory)
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
64 data_manager_dict = {}
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
65
0
00491eabe22b planemo upload commit e4c87b7392ace0d6ac5ba2d926e1dd176f987985
devteam
parents:
diff changeset
66 dbkey = options.fasta_dbkey
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
67
3
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
68 if dbkey in [None, '', '?']:
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
69 raise Exception('"%s" is not a valid dbkey. You must specify a valid dbkey.' % (dbkey))
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
70
3
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
71 sequence_id, sequence_name = get_id_name(params, dbkey=dbkey, fasta_description=options.fasta_description)
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
72
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
73 # build the index
3
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
74 build_picard_index(data_manager_dict, options.fasta_filename, params, target_directory, dbkey, sequence_id,
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
75 sequence_name, data_table_name=options.data_table_name or DEFAULT_DATA_TABLE_NAME)
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
76
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
77 # save info to json file
3
ae080ff506fd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 31fc4022a8c2fef50a3aff9210091be21e8450ef"
iuc
parents: 2
diff changeset
78 open(filename, 'w').write(dumps(data_manager_dict, sort_keys=True))
1
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
79
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
80
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
81 if __name__ == "__main__":
dc28cd6a1d44 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_picard_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 0
diff changeset
82 main()