annotate data_manager/hisat2_index_builder.xml @ 8:e4f36467bb51 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
author iuc
date Sat, 16 Aug 2025 14:36:15 +0000
parents 8eac26f44d29
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
1 <tool id="hisat2_index_builder_data_manager" name="HISAT2 index" tool_type="manage_data" version="@WRAPPER_VERSION@+galaxy@VERSION_SUFFIX@" profile="23.0">
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
2 <description>builder</description>
8
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
3 <macros>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
4 <token name="@WRAPPER_VERSION@">2.2.1</token>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
5 <token name="@VERSION_SUFFIX@">1</token>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
6 </macros>
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
7 <requirements>
8
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
8 <requirement type="package" version="@WRAPPER_VERSION@">hisat2</requirement>
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
9 </requirements>
4
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
8
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
11 #set $value = $sequence_id or $all_fasta_source.fields.dbkey
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
12 #set $fasta_file_name = str($all_fasta_source.fields.path).split('/')[-1]
2
4014cb2c17db planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 4a5952b2404c0821cf9895cb2a5036da62b14d6e-dirty
iuc
parents: 1
diff changeset
13 #if $advanced.adv_param_select == 'yes' and $advanced.gtf_input:
4
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
14 ln -s '${advanced.gtf_input}' gtf_file.gtf &&
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
15 hisat2_extract_splice_sites.py gtf_file.gtf > splice_sites.txt &&
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
16 hisat2_extract_exons.py gtf_file.gtf > exon.txt &&
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
17 #end if
2
4014cb2c17db planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 4a5952b2404c0821cf9895cb2a5036da62b14d6e-dirty
iuc
parents: 1
diff changeset
18 #if $advanced.adv_param_select == 'yes' and $advanced.snps:
4
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
19 ln -s '${advanced.snps}' snps.tabular &&
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
20 #if $advanced.snps.is_of_type('vcf')
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
21 hisat2_extract_snps_haplotypes_VCF.py '${all_fasta_source.fields.path}' snps.tabular extracted &&
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
22 #else
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
23 hisat2_extract_snps_haplotypes_UCSC.py '${all_fasta_source.fields.path}' snps.tabular extracted &&
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
24 #end if
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
25 #end if
8
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
26
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
27 mkdir -p '${out_file.extra_files_path}' &&
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
28 ln -s '${all_fasta_source.fields.path}' '${out_file.extra_files_path}/${fasta_file_name}' &&
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
29 working="\$(pwd)" &&
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
30 cd '${out_file.extra_files_path}' &&
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
31
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
32 hisat2-build -p "\${GALAXY_SLOTS:-1}"
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
33 #if $advanced.adv_param_select == 'yes':
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
34 --noauto
4
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
35 #if $advanced.snps:
8
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
36 --snp "\${working}/extracted.snp"
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
37 --haplotype "\${working}/extracted.haplotype"
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
38 #end if
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
39 #if $advanced.gtf_input:
8
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
40 --ss "\${working}/splice_sites.txt"
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
41 --exon "\${working}/exon.txt"
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
42 #end if
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
43 --bmax $advanced.bmax
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
44 --bmaxdivn $advanced.bmaxdivn
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
45 --dcv $advanced.dcv
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
46 --offrate $advanced.offrate
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
47 #end if
8
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
48 '${fasta_file_name}' '${value}' &&
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
49 rm '${out_file.extra_files_path}/${fasta_file_name}' &&
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
50
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
51 cp '$dmjson' '$out_file'
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
52 ]]>
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
53 </command>
8
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
54 <configfiles>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
55 <configfile name="dmjson"><![CDATA[#slurp
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
56 #set $fasta_file_name = str($all_fasta_source.fields.path).split('/')[-1]
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
57 #set $value = $sequence_id or $all_fasta_source.fields.dbkey
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
58 #set $name = $sequence_name or $all_fasta_source.fields.name
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
59 {
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
60 "data_tables":{
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
61 "hisat2_indexes":[
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
62 {
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
63 "value": "${value}",
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
64 "dbkey": "${all_fasta_source.fields.dbkey}",
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
65 "name": "${name}",
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
66 "path": "${value}"
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
67 }
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
68 ]
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
69 }
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
70 }
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
71 ]]></configfile>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
72 </configfiles>
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
73 <inputs>
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
74 <param label="Source FASTA Sequence" name="all_fasta_source" type="select">
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
75 <options from_data_table="all_fasta" />
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
76 </param>
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
77 <conditional name="advanced" label="Advanced parameters">
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
78 <param name="adv_param_select" type="select" label="Advanced parameters">
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
79 <option value="no">Use defaults</option>
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
80 <option value="yes">Fine-tune indexing parameters</option>
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
81 </param>
4
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
82 <when value="no" />
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
83 <when value="yes">
4
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
84 <param argument="--bmax" type="integer" value="4" label="Maximum number of suffixes allowed in a block" />
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
85 <param argument="--bmaxdivn" type="integer" value="4" label="Maximum number of suffixes allowed in a block, expressed as a fraction of the length of the reference" />
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
86 <param argument="--dcv" type="integer" min="2" max="4096" value="1024" label="Period for the difference-cover sample" help="A larger period yields less memory overhead, but may make suffix sorting slower, especially if repeats are present. Must be a power of 2 no greater than 4096" />
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
87 <param argument="--offrate" type="integer" value="4" label="Mark rows in the Burrows-Wheeler transform" help="To map alignments back to positions on the reference sequences, it's necessary to annotate (&quot;mark&quot;) some or all of the Burrows-Wheeler rows with their corresponding location on the genome. This parameter governs how many rows get marked: the indexer will mark every 2^&lt;int&gt; rows. Marking more rows makes reference-position lookups faster, but requires more memory to hold the annotations at runtime. The default is 4 (every 16th row is marked; for human genome, annotations occupy about 680 megabytes)" />
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
88 <param name="snps" type="data" format="tabular,vcf" optional="true" label="Provide a list of SNPs in the UCSC dbSNP or VCF format" help="If you include SNPs or splice sites and exons, building an index on the human genome will consume up to 200GB RAM as index building involves a graph construction" />
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
89 <param name="gtf_input" type="data" format="gtf" optional="true" label="Provide a GTF file for HISAT2 to extract splice sites from" help="If you include SNPs or splice sites and exons, building an index on the human genome will consume up to 200GB RAM as index building involves a graph construction" />
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
90 </when>
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
91 </conditional>
4
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
92 <param name="sequence_name" type="text" value="" label="Name of sequence" />
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
93 <param name="sequence_id" type="text" value="" label="ID for sequence" />
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
94 </inputs>
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
95 <outputs>
4
d210e1f185bd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 8652f36a3a3838dca989426961561e81432acf4f
iuc
parents: 2
diff changeset
96 <data name="out_file" format="data_manager_json" />
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
97 </outputs>
5
8eac26f44d29 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 05c191c21eba39e75a8c8d6e6a00d8db63552695"
iuc
parents: 4
diff changeset
98 <tests>
8eac26f44d29 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 05c191c21eba39e75a8c8d6e6a00d8db63552695"
iuc
parents: 4
diff changeset
99 <test>
8eac26f44d29 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 05c191c21eba39e75a8c8d6e6a00d8db63552695"
iuc
parents: 4
diff changeset
100 <param name="all_fasta_source" value="phiX174"/>
8
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
101 <output name="out_file" file="hisat2_data_manager.1.json"/>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
102 </test>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
103 <test>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
104 <param name="all_fasta_source" value="phiX174"/>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
105 <param name="sequence_name" value="Galeocerdo cuvier"/>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
106 <param name="sequence_id" value="tigHai1"/>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
107 <param name="advanced|adv_param_select" value="yes"/>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
108 <param name="advanced|bmax" value="3"/>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
109 <param name="advanced|bmaxdivn" value="3"/>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
110 <param name="advanced|dcv" value="4"/>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
111 <param name="advanced|offrate" value="5"/>
e4f36467bb51 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit e5971e34b23280f7c3d6291a03325b6dd47e3fdd
iuc
parents: 5
diff changeset
112 <output name="out_file" file="hisat2_data_manager.2.json"/>
5
8eac26f44d29 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 05c191c21eba39e75a8c8d6e6a00d8db63552695"
iuc
parents: 4
diff changeset
113 </test>
8eac26f44d29 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_hisat2_index_builder commit 05c191c21eba39e75a8c8d6e6a00d8db63552695"
iuc
parents: 4
diff changeset
114 </tests>
0
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
115 <help>
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
116 <![CDATA[
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
117 .. class:: infomark
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
118
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
119 **Notice:** If you leave name, description, or id blank, it will be generated automatically.
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
120
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
121 What is HISAT2?
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
122 ---------------
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
123
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
124 `HISAT <http://ccb.jhu.edu/software/hisat>`__ is a fast and sensitive alignment
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
125 program for mapping next-generation sequencing reads (both DNA and RNA) against
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
126 the general human population (as well as against a single reference genome).
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
127 Based on an extension of BWT for graphs (`BWT <http://dl.acm.org/citation.cfm?id=2674828>`__)
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
128 we designed and implemented a graph FM index (GFM), an original approach and
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
129 its first implementation to the best of our knowledge. In addition to using one
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
130 global GFM index that represents the general population, HISAT2 uses a large set
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
131 of small GFM indexes that collectively cover the whole genome (each index
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
132 representing a genomic region of 56 Kbp, with 55,000 indexes needed to cover
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
133 the human population). These small indexes (called local indexes), combined
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
134 with several alignment strategies, enable rapid and accurate alignment of
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
135 sequencing reads. This new indexing scheme is called a Hierarchical Graph
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
136 FM index (HGFM). In addition to spliced alignment, HISAT handles reads
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
137 involving indels and supports a paired-end alignment mode. Multiple processors
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
138 can be used simultaneously to achieve greater alignment speed. HISAT outputs
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
139 alignments in `SAM <http://samtools.sourceforge.net/SAM1.pdf>`__ format, enabling
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
140 interoperation with a large number of other tools (e.g. `SAMtools <http://samtools.sourceforge.net>`__,
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
141 `GATK <http://www.broadinstitute.org/gsa/wiki/index.php/The_Genome_Analysis_Toolkit>`__)
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
142 that use SAM. HISAT is distributed under the `GPLv3 license <http://www.gnu.org/licenses/gpl-3.0.html>`__,
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
143 and it runs on the command line under Linux, Mac OS X and Windows.
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
144 ]]>
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
145 </help>
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
146 <citations>
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
147 <citation type="doi">10.1038/nmeth.3317</citation>
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
148 </citations>
d3eb4d51b285 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/data_managers/data_manager_hisat2_index_builder commit 1e8d3feeb391aabcfff2338b57913138deea51ec-dirty
iuc
parents:
diff changeset
149 </tool>