Mercurial > repos > devteam > picard

annotate picard_ReorderSam.xml @ 32:f9242e01365a draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 285fab1660daa944d6833ae1e059b30cb1e88309
author iuc
date Mon, 25 Sep 2023 08:32:17 +0000
parents 881d7645d1bf
children 3f254c5ced1d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 14
diff changeset
1 <tool name="ReorderSam" id="picard_ReorderSam" version="@TOOL_VERSION@.@WRAPPER_VERSION@">
28
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
2 <description>reorder reads to match ordering in reference sequences</description>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
3 <macros>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
4 <import>picard_macros.xml</import>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
5 <token name="@WRAPPER_VERSION@">1</token>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
6 </macros>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
7 <xrefs>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
8 <xref type="bio.tools">picard_reordersam</xref>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
9 </xrefs>
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
10 <expand macro="requirements" />
881d7645d1bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
iuc
parents: 20
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
12 @java_options@
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
13 @symlink_element_identifier@
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
14 #set $picard_dict = "localref.dict"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
15 #set $ref_fasta = "localref.fa" ## This is done because picards "likes" .fa extension
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
16
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
17 ln -s "${reference_source.ref_file}" "${ref_fasta}" &&
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
18
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
19 #if str( $reference_source.reference_source_selector ) == "history":
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
20
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
21 picard CreateSequenceDictionary REFERENCE="${ref_fasta}" OUTPUT="${picard_dict}"
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
22 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
23 VERBOSITY=ERROR
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
24
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
25 &&
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
26
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
27 #else:
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
28
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
29 #set $ref_fasta = str( $reference_source.ref_file.fields.path )
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
30
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
31 #end if
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
32
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
33 picard
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
34 ReorderSam
14
465cbb0cf2eb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
devteam
parents: 13
diff changeset
35 INPUT='$escaped_element_identifier'
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
36 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
37 REFERENCE="${ref_fasta}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
38 ALLOW_INCOMPLETE_DICT_CONCORDANCE="${allow_incomplete_dict_concordance}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
39 ALLOW_CONTIG_LENGTH_DISCORDANCE="${allow_contig_length_discordance}"
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
40
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
41 VALIDATION_STRINGENCY="${validation_stringency}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
42 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
43 VERBOSITY=ERROR
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
44
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
45 ]]></command>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
46
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
47 <inputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
48
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
49 <conditional name="reference_source">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
50 <param name="reference_source_selector" type="select" label="Load reference genome from">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
51 <option value="cached">Local cache</option>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
52 <option value="history">History</option>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
53 </param>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
54 <when value="cached">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
55 <param name="ref_file" type="select" label="Use dictionary from the list" help="Select genome from the list">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
56 <options from_data_table="picard_indexes">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
57 <filter type="sort_by" column="2" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
58 <validator type="no_options" message="No indexes are available" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
59 </options>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
60 <validator type="no_options" message="A built-in dictionary is not available for the build associated with the selected input file"/>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
61 </param>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
62 </when>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
63 <when value="history">
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
64 <param name="ref_file" type="data" format="fasta" label="Use the following dataset to create dictionary" help="You can upload a FASTA sequence to the history from which Picard will automatically generate dictionary using CreateSequenceDictionary command" />
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
65 </when>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
66 </conditional>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
67
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
68 <param format="sam,bam" name="inputFile" type="data" label="Select SAM/BAM dataset or dataset collection" help="If empty, upload or import a SAM/BAM dataset"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
69 <param name="allow_incomplete_dict_concordance" type="boolean" label="If true, then allows only a partial overlap of the BAM contigs with the new reference sequence contigs" help="ALLOW_INCOMPLETE_DICT_CONCORDANCE; By default, this tool requires a corresponding contig in the new reference for each read contig; default=False"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
70 <param name="allow_contig_length_discordance" type="boolean" label="If true, then permits mapping from a read contig to a new reference contig with the same name but a different length" help="ALLOW_CONTIG_LENGTH_DISCORDANCE; HIGHLY DANGEROUS! Only use if you know what you are doing; default=False"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
71 <expand macro="VS" />
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
72
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
73 </inputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
74 <outputs>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
75 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: Reordered BAM"/>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
76 </outputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
77 <tests>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
78 <test>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
79 <param name="reference_source_selector" value="history" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
80 <param name="ref_file" value="picard_ReorderSam_ref.fa" ftype="fasta" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
81 <param name="inputFile" value="picard_ReorderSam.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
82 <param name="allow_incomplete_dict_concordance" value="false"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
83 <param name="allow_contig_length_discordance" value="false"/>
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
84 <output name="outFile" file="picard_ReorderSam_test1.bam" ftype="bam" lines_diff="4"/>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
85 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
86 </tests>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
87
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
88
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
89 <help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
90
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
91 .. class:: infomark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
92
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
93 **Purpose**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
94
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
95 ReorderSam reorders reads in a SAM/BAM file to match the contig ordering in a provided reference file, as determined by exact name matching of contigs. Reads mapped to contigs absent in the new reference are dropped.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
96
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
97 @dataset_collections@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
98
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
99 ----
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
100
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
101 .. class:: warningmark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
102
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
103 Not to be confused with **SortSam**.
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
104
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
105 @description@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
106
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
107 ALLOW_INCOMPLETE_DICT_CONCORDANCE=Boolean
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
108 S=Boolean If true, then allows only a partial overlap of the BAM contigs with the new reference
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
109 sequence contigs. By default, this tool requires a corresponding contig in the new
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
110 reference for each read contig Default value: false. Possible values: {true, false}
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
111
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
112 ALLOW_CONTIG_LENGTH_DISCORDANCE=Boolean
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
113 U=Boolean If true, then permits mapping from a read contig to a new reference contig with the same
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
114 name but a different length. Highly dangerous, only use if you know what you are doing.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
115 Default value: false. Possible values: {true, false}
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
116
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
117 @more_info@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
118 </help>
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 14
diff changeset
119 <expand macro="citations" />
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
120 </tool>