Mercurial > repos > devteam > picard
annotate picard_RevertSam.xml @ 30:b502c227b5e6 draft
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 0244aa33464cc27d1ce881cb310b8eda36e9a89c
author | iuc |
---|---|
date | Mon, 22 Aug 2022 09:56:00 +0000 |
parents | 2a17c789e0a5 |
children | f9242e01365a |
rev | line source |
---|---|
19
5053a18d9bc8
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents:
13
diff
changeset
|
1 <tool name="RevertSam" id="picard_RevertSam" version="@TOOL_VERSION@.@WRAPPER_VERSION@"> |
5 | 2 <description>revert SAM/BAM datasets to a previous state</description> |
3 <macros> | |
4 <import>picard_macros.xml</import> | |
20
2a17c789e0a5
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 5ebd6c8453b49dd6a36e372eb1eb6e323bb7ad8a
iuc
parents:
19
diff
changeset
|
5 <token name="@WRAPPER_VERSION@">1</token> |
5 | 6 </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
|
7 <expand macro="requirements" /> |
12
05087b27692a
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents:
9
diff
changeset
|
8 <command detect_errors="exit_code"><![CDATA[ |
5 | 9 @java_options@ |
12
05087b27692a
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents:
9
diff
changeset
|
10 picard |
5 | 11 RevertSam |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
12 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
13 INPUT='$inputFile' |
5 | 14 OUTPUT="${outFile}" |
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 | 16 RESTORE_ORIGINAL_QUALITIES="${restore_original_qualities}" |
17 REMOVE_DUPLICATE_INFORMATION="${remove_duplicate_information}" | |
18 REMOVE_ALIGNMENT_INFORMATION="${remove_alignment_information}" | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
19 |
5 | 20 #for $attribute_to_clear in $attributes_to_clear: |
21 ATTRIBUTE_TO_CLEAR="${attribute_to_clear.attribute}" | |
22 #end for | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
23 |
5 | 24 SANITIZE="${sanitize}" |
25 MAX_DISCARD_FRACTION="${max_discard_fraction}" | |
26 SAMPLE_ALIAS="${sample_alias}" | |
27 LIBRARY_NAME="${library_name}" | |
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 | 29 SORT_ORDER="${sort_order}" |
30 VALIDATION_STRINGENCY="${validation_stringency}" | |
31 QUIET=true | |
32 VERBOSITY=ERROR | |
20
2a17c789e0a5
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 5ebd6c8453b49dd6a36e372eb1eb6e323bb7ad8a
iuc
parents:
19
diff
changeset
|
33 @TMPDIR_OPTION@ |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
34 |
12
05087b27692a
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents:
9
diff
changeset
|
35 ]]></command> |
5 | 36 <inputs> |
37 <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"/> | |
38 <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"/> | |
39 <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"/> | |
40 <param name="remove_alignment_information" type="boolean" checked="True" label="Remove all alignment information from the file" help="REMOVE_ALIGNMENT_INFORMATION; default=True"/> | |
41 <repeat name="attributes_to_clear" title="Clear attribute" min="0" help="You can provide multiple attributes"> | |
9
5eaa8a968300
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents:
8
diff
changeset
|
42 <param name="attribute" type="text" label="When removing alignment information, specify optional tags to remove (e.g., XM)" help="ATTRIBUTE_TO_CLEAR"/> |
5 | 43 </repeat> |
44 <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"/> | |
45 <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"/> | |
9
5eaa8a968300
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents:
8
diff
changeset
|
46 <param name="sample_alias" type="text" 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"/> |
5eaa8a968300
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents:
8
diff
changeset
|
47 <param name="library_name" type="text" 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"/> |
5 | 48 <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"> |
49 <option value="coordinate" selected="True">Coordinate</option> | |
50 <option value="queryname">Queryname</option> | |
51 <option value="unsorted">Unsorted</option> | |
52 </param> | |
53 <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
|
54 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
55 </inputs> |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
56 |
5 | 57 <outputs> |
58 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: Reverted BAM dataset"/> | |
59 </outputs> | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
60 |
5 | 61 <tests> |
62 <test> | |
63 <param name="inputFile" value="picard_RevertSam.bam" ftype="bam"/> | |
64 <param name="restore_original_qualities" value="True"/> | |
65 <param name="remove_duplicate_information" value="True"/> | |
66 <param name="remove_alignment_information" value="True"/> | |
67 <param name="attribute" value="XM"/> | |
68 <param name="sanitize" value="False"/> | |
69 <param name="max_discard_fraction" value="0.01"/> | |
70 <param name="sample_alias" value="null"/> | |
71 <param name="library_name" value="null"/> | |
72 <param name="sort_order" value="coordinate"/> | |
73 <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:
9
diff
changeset
|
74 <output name="outFile" file="picard_RevertSam_test1.bam" ftype="bam" lines_diff="4"/> |
5 | 75 </test> |
76 </tests> | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
77 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
78 |
5 | 79 <help> |
80 | |
81 **Purpose** | |
82 | |
83 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. | |
84 | |
85 @dataset_collections@ | |
86 | |
87 @description@ | |
88 | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
89 SORT_ORDER=SortOrder |
5 | 90 SO=SortOrder The sort order to create the reverted output file with. Default value: queryname. |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
91 Possible values: {unsorted, queryname, coordinate} |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
92 |
5 | 93 RESTORE_ORIGINAL_QUALITIES=Boolean |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
94 OQ=Boolean True to restore original qualities from the OQ field to the QUAL field if available. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
95 Default value: true. 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
|
96 |
5 | 97 REMOVE_DUPLICATE_INFORMATION=Boolean |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
98 Remove duplicate read flags from all reads. Note that if this is true and |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
99 REMOVE_ALIGNMENT_INFORMATION==false, the output may have the unusual but sometimes |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
100 desirable trait of having unmapped reads that are marked as duplicates. Default value: |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
101 true. 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
|
102 |
5 | 103 REMOVE_ALIGNMENT_INFORMATION=Boolean |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
104 Remove all alignment information from the file. Default value: true. TPossible 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
|
105 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
106 ATTRIBUTE_TO_CLEAR=String When removing alignment information, the set of optional tags to remove. This option may |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
107 be specified 0 or more times. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
108 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
109 SANITIZE=Boolean WARNING: This option is potentially destructive. If enabled will discard reads in order |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
110 to produce a consistent output BAM. Reads discarded include (but are not limited to) |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
111 paired reads with missing mates, duplicated records, records with mismatches in length of |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
112 bases and qualities. This option can only be enabled if the output sort order is |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
113 queryname and will always cause sorting to occur. 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
|
114 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
115 MAX_DISCARD_FRACTION=Double If SANITIZE=true and higher than MAX_DISCARD_FRACTION reads are discarded due to |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
116 sanitization thenthe program will exit with an Exception instead of exiting cleanly. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
117 Output BAM will still be valid. Default value: 0.01. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
118 |
5 | 119 SAMPLE_ALIAS=String |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
120 ALIAS=String The sample alias to use in the reverted output file. This will override the existing |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
121 sample alias in the file and is used only if all the read groups in the input file have |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
122 the same sample alias Default value: null. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
123 |
5 | 124 LIBRARY_NAME=String |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
125 LIB=String The library name to use in the reverted output file. This will override the existing |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
126 sample alias in the file and is used only if all the read groups in the input file have |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
127 the same sample alias Default value: null. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
128 |
5 | 129 @more_info@ |
130 | |
131 </help> | |
19
5053a18d9bc8
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents:
13
diff
changeset
|
132 <expand macro="citations" /> |
5 | 133 </tool> |