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