annotate picard_RevertSam.xml @ 7:379fdf4c41ac draft

Uploaded
author devteam
date Thu, 29 Jan 2015 16:11:15 -0500
parents 3d4f1fa26f0e
children 3a3234d7a2e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
1 <tool name="RevertSam" id="picard_RevertSam" version="1.126.0">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
2 <description>revert SAM/BAM datasets to a previous state</description>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
3 <requirements>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
4 <requirement type="package" version="1.126.0">picard</requirement>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
5 </requirements>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
6
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
7 <macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
8 <import>picard_macros.xml</import>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
9 </macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
10
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
11 <command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
12 @java_options@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
13
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
14 java -jar \$JAVA_JAR_PATH/picard.jar
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
15 RevertSam
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
16
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
17 INPUT="${inputFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
18 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
19
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
20 RESTORE_ORIGINAL_QUALITIES="${restore_original_qualities}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
21 REMOVE_DUPLICATE_INFORMATION="${remove_duplicate_information}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
22 REMOVE_ALIGNMENT_INFORMATION="${remove_alignment_information}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
23
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
24 #for $attribute_to_clear in $attributes_to_clear:
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
25 ATTRIBUTE_TO_CLEAR="${attribute_to_clear.attribute}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
26 #end for
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
27
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
28 SANITIZE="${sanitize}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
29 MAX_DISCARD_FRACTION="${max_discard_fraction}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
30 SAMPLE_ALIAS="${sample_alias}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
31 LIBRARY_NAME="${library_name}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
32
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
33 SORT_ORDER="${sort_order}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
34 VALIDATION_STRINGENCY="${validation_stringency}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
35 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
36 VERBOSITY=ERROR
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
37
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 </command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
40 <param format="sam,bam" name="inputFile" type="data" multiple="True" label="Select SAM/BAM dataset or dataset collection" help="If empty, upload or import a SAM/BAM dataset"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
41 <param name="restore_original_qualities" type="boolean" checked="True" label="Restore original qualities from the OQ field to the QUAL field if available" help="RESTORE_ORIGINAL_QUALITIES; default=True"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42 <param name="remove_duplicate_information" type="boolean" checked="True" label="Remove duplicate read flags from all reads" help="REMOVE_DUPLICATE_INFORMATION; Note that if this is true and REMOVE_ALIGNMENT_INFORMATION is set to False, the output may have the unusual but sometimes desirable trait of having unmapped reads that are marked as duplicates; default=True"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43 <param name="remove_alignment_information" type="boolean" checked="True" label="Remove all alignment information from the file" help="REMOVE_ALIGNMENT_INFORMATION; default=True"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
44 <repeat name="attributes_to_clear" title="Clear attribute" min="0" help="You can provide multiple attributes">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
45 <param name="attribute" type="text" size="10" label="When removing alignment information, specify optional tags to remove (e.g., XM)" help="ATTRIBUTE_TO_CLEAR"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46 </repeat>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47 <param name="sanitize" type="boolean" label="Discard reads in order to produce a consistent output BAM" help="SANITIZE; WARNING: This option is potentially destructive. Reads discarded include (but are not limited to) paired reads with missing mates, duplicated records, records with mismatches in length of bases and qualities. This option can only be enabled if the output sort order is queryname and will always cause sorting to occur; default=False"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48 <param name="max_discard_fraction" value="0.01" type="float" min="0.0" max="1.0" label="If SANITIZE=true and higher than MAX_DISCARD_FRACTION reads are discarded due to sanitization then the program will exit with an Exception instead of exiting cleanly" help="MAX_DISCARD_FRACTION; default=0.01"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
49 <param name="sample_alias" type="text" size="40" value="null" label="The sample alias to use in the reverted output file. This will override the existing sample alias in the file and is used only if all the read groups in the input file have the same sample alias" help="SAMPLE_ALIAS; default=Null"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50 <param name="library_name" type="text" size="40" value="null" label="The library name to use in the reverted output file. This will override the existing sample alias in the file and is used only if all the read groups in the input file have the same sample alias" help="LIBRARY_NAME; default=Null"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51 <param name="sort_order" type="select" label="The sort order to create the reverted output file with" help="SORT_ORDER; Picard default=queryname; Galaxy default=coordinate">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52 <option value="coordinate" selected="True">Coordinate</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53 <option value="queryname">Queryname</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
54 <option value="unsorted">Unsorted</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
55 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
56 <expand macro="VS" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
57
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
58 </inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
59
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
60 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: Reverted BAM dataset"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
62 </outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
64 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
65 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
66 <param name="inputFile" value="picard_RevertSam.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
67 <param name="restore_original_qualities" value="True"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
68 <param name="remove_duplicate_information" value="True"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
69 <param name="remove_alignment_information" value="True"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
70 <param name="attribute" value="XM"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
71 <param name="sanitize" value="False"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
72 <param name="max_discard_fraction" value="0.01"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
73 <param name="sample_alias" value="null"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
74 <param name="library_name" value="null"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
75 <param name="sort_order" value="coordinate"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
76 <param name="validation_stringency" value="LENIENT"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
77 <output name="outFile" file="picard_RevertSam_test1.bam" ftype="bam" lines_diff="2"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
78 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
79 </tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
80
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
81 <stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
82 <exit_code range="1:" level="fatal"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
83 </stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
84
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
85 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
86
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
87 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
88
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
89 Reverts SAM or BAM files to a previous state by removing certain types of information and/or substituting in the original quality scores when available.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
90
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
91 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
92
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
93 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
94
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
95 SORT_ORDER=SortOrder
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
96 SO=SortOrder The sort order to create the reverted output file with. Default value: queryname.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
97 Possible values: {unsorted, queryname, coordinate}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
98
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
99 RESTORE_ORIGINAL_QUALITIES=Boolean
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
100 OQ=Boolean True to restore original qualities from the OQ field to the QUAL field if available.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
101 Default value: true. Possible values: {true, false}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
102
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
103 REMOVE_DUPLICATE_INFORMATION=Boolean
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
104 Remove duplicate read flags from all reads. Note that if this is true and
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
105 REMOVE_ALIGNMENT_INFORMATION==false, the output may have the unusual but sometimes
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
106 desirable trait of having unmapped reads that are marked as duplicates. Default value:
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
107 true. Possible values: {true, false}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
108
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
109 REMOVE_ALIGNMENT_INFORMATION=Boolean
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
110 Remove all alignment information from the file. Default value: true. TPossible values: {true, false}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
111
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
112 ATTRIBUTE_TO_CLEAR=String When removing alignment information, the set of optional tags to remove. This option may
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
113 be specified 0 or more times.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
114
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
115 SANITIZE=Boolean WARNING: This option is potentially destructive. If enabled will discard reads in order
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
116 to produce a consistent output BAM. Reads discarded include (but are not limited to)
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
117 paired reads with missing mates, duplicated records, records with mismatches in length of
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
118 bases and qualities. This option can only be enabled if the output sort order is
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
119 queryname and will always cause sorting to occur. Possible values: {true, false}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
120
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
121 MAX_DISCARD_FRACTION=Double If SANITIZE=true and higher than MAX_DISCARD_FRACTION reads are discarded due to
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
122 sanitization thenthe program will exit with an Exception instead of exiting cleanly.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
123 Output BAM will still be valid. Default value: 0.01.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
124
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
125 SAMPLE_ALIAS=String
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
126 ALIAS=String The sample alias to use in the reverted output file. This will override the existing
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
127 sample alias in the file and is used only if all the read groups in the input file have
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
128 the same sample alias Default value: null.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
129
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
130 LIBRARY_NAME=String
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
131 LIB=String The library name to use in the reverted output file. This will override the existing
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
132 sample alias in the file and is used only if all the read groups in the input file have
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
133 the same sample alias Default value: null.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
134
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
135 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
136
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
137 </help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
138 </tool>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
139
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
140