annotate picard_FixMateInformation.xml @ 0:5166ed57b1c4 draft

Uploaded version 1.135
author avowinkel
date Mon, 06 Jul 2015 14:46:32 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
1 <tool name="FixMateInformation" id="picard_FixMateInformation" version="1.135">
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
2 <description>ensure that all mate-pair information is in sync between each read and it's mate pair</description>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
3 <macros>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
4 <import>picard_macros.xml</import>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
5 </macros>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
6 <expand macro="requirements" />
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
7 <command>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
8 @java_options@
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
9
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
10 java -jar \$JAVA_JAR_PATH/picard.jar
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
11 FixMateInformation
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
12 INPUT="${inputFile}"
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
13 OUTPUT="${outFile}"
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
14 ASSUME_SORTED=${assume_sorted}
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
15 ADD_MATE_CIGAR=${add_mate_cigar}
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
16
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
17 SORT_ORDER=coordinate
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
18 VALIDATION_STRINGENCY="${validation_stringency}"
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
19 QUIET=true
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
20 VERBOSITY=ERROR
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
21
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
22 </command>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
23 <inputs>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
24 <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"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
25 <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"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
26 <param name="assume_sorted" type="boolean" truevalue="True" falsevalue="False" label="Assume that the input file is QUERYNAME sorted" help="ASSUME_SORTED; default=False"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
27
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
28 <expand macro="VS" />
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
29
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
30 </inputs>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
31
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
32 <outputs>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
33 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: BAM with fixed mates"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
34 </outputs>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
35
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
36 <tests>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
37 <test>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
38 <param name="inputFile" value="picard_FixMateInformation.bam" ftype="bam"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
39 <param name="add_mate_cigar" value="True"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
40 <param name="assume_sorted" value="False"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
41 <param name="validation_stringency" value="LENIENT"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
42 <output name="outFile" file="picard_FixMateInformation_test1.bam" ftype="bam" lines_diff="2"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
43 </test>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
44 </tests>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
45
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
46 <stdio>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
47 <exit_code range="1:" level="fatal"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
48 </stdio>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
49
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
50 <help>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
51
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
52 **Purpose**
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
53
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
54 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.
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
55
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
56 ------
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
57
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
58 .. class:: warningmark
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
59
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
60 **Warning on using ASSUME_SORTED option**
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
61
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
62 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
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
63 is to assume that the BAM you are working with is coordinate sorted.
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
64
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
65 @dataset_collections@
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
66
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
67 @description@
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
68
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
69 ASSUME_SORTED=Boolean
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
70 AS=Boolean If true, assume that the input file is queryname sorted, even if the header says
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
71 otherwise. Default value: false.
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
72
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
73 ADD_MATE_CIGAR=Boolean
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
74 MC=Boolean Adds the mate CIGAR tag (MC) if true, does not if false. Default value: true.
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
75
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
76 @more_info@
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
77
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
78 </help>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
79 </tool>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
80
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
81