Mercurial > repos > devteam > picard

annotate picard_FixMateInformation.xml @ 18:7615ac66c6e5 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 3ce5dea3af8f4816b4a83914b53402aa84e08fca
author iuc
date Sat, 20 Jan 2018 08:28:24 -0500
parents 7e6fd3d0f16e
children 5053a18d9bc8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
1 <tool name="FixMateInformation" id="picard_FixMateInformation" version="@TOOL_VERSION@.0">
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
2 <description>ensure that all mate-pair information is in sync between each read and it's mate pair</description>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
3 <macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
4 <import>picard_macros.xml</import>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
5 </macros>
8
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
6 <expand macro="requirements" />
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
8 @java_options@
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
9 picard
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
10 FixMateInformation
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
11 INPUT="${inputFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
12 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
13 ASSUME_SORTED=${assume_sorted}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
14 ADD_MATE_CIGAR=${add_mate_cigar}
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
15
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
16 SORT_ORDER=coordinate
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
17 VALIDATION_STRINGENCY="${validation_stringency}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
18 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
19 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
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 ]]></command>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
22 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
23 <param name="inputFile" multiple="True" type="data" format="sam,bam" label="Select SAM/BAM dataset or dataset collection" help="If empty, upload or import a SAM/BAM dataset"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
24 <param name="add_mate_cigar" type="boolean" checked="true" truevalue="True" falsevalue="False" label="Adds the mate CIGAR tag (MC) if true, does not if false" help="ADD_MATE_CIGAR; default=True"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
25 <param name="assume_sorted" type="boolean" truevalue="True" falsevalue="False" label="Assume that the input file is QUERYNAME sorted" help="ASSUME_SORTED; default=False"/>
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:
diff changeset
27 <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
28
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
29 </inputs>
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:
diff changeset
31 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
32 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: BAM with fixed mates"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
33 </outputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
34
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
35 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
36 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
37 <param name="inputFile" value="picard_FixMateInformation.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 <param name="add_mate_cigar" value="True"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39 <param name="assume_sorted" value="False"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
40 <param name="validation_stringency" value="LENIENT"/>
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
41 <output name="outFile" file="picard_FixMateInformation_test1.bam" ftype="bam" lines_diff="4"/>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43 </tests>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
44
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
45
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
49
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50 Ensure that all mate-pair information is in sync between each read and it's mate pair. Reads marked with the secondary alignment flag are written to the output file unchanged.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52 ------
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
54 .. class:: warningmark
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
55
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
56 **Warning on using ASSUME_SORTED option**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
57
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
58 Datasets imported into Galaxy are automatically coordinate sorted. So use this option (set it to True) only if you are sure that this is necessary. If you are not sure - a good rule of thumb
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
59 is to assume that the BAM you are working with is coordinate sorted.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
60
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
62
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
64
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
65 ASSUME_SORTED=Boolean
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
66 AS=Boolean If true, assume that the input file is queryname sorted, even if the header says
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
67 otherwise. Default value: false.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
68
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
69 ADD_MATE_CIGAR=Boolean
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
70 MC=Boolean Adds the mate CIGAR tag (MC) if true, does not if false. Default value: true.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
71
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
72 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
73
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
74 </help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
75 </tool>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
76
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
77