annotate picard_FixMateInformation.xml @ 124:5a39cfd995b3 draft

Uploaded
author devteam
date Wed, 26 Feb 2014 00:28:03 -0500
parents ae3d9a7c8399
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
103
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
1 <tool name="Paired Read Mate Fixer" id="rgPicFixMate" version="1.106.0">
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
2 <description>for paired data</description>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
3 <command interpreter="python">
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
4 picard_wrapper.py -i "${input_file}" -o "${out_file}" --tmpdir "${__new_file_path__}" -n "${out_prefix}"
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
5 --output-format "${outputFormat}" -j "\$JAVA_JAR_PATH/FixMateInformation.jar" --sortorder "${sortOrder}"
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
6 </command>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
7 <requirements><requirement type="package" version="1.106.0">picard</requirement></requirements>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
8 <inputs>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
9 <param format="bam,sam" name="input_file" type="data" label="SAM/BAM dataset to fix"
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
10 help="If empty, upload or import a SAM/BAM dataset."/>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
11 <param name="sortOrder" type="select" help="If in doubt, leave as default and read Picard/Samtools documentation"
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
12 label="Sort order">
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
13 <option value="coordinate" selected ="true">Coordinate sort</option>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
14 <option value="queryname">Query name sort</option>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
15 <option value="unsorted">Unsorted - docs not clear if this means unchanged or not</option>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
16 </param>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
17 <param name="out_prefix" value="Fix Mate" type="text"
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
18 label="Title for the output file" help="Use this remind you what the job was for." size="80" />
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
19 <param name="outputFormat" type="boolean" checked="True" truevalue="bam" falsevalue="sam" label="Output BAM instead of SAM" help="Uncheck for SAM output" />
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
20 </inputs>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
21 <outputs>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
22 <data format="bam" name="out_file" label="${tool.name} on ${on_string}: ${outputFormat} with fixed mates">
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
23 <change_format>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
24 <when input="outputFormat" value="sam" format="sam" />
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
25 </change_format>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
26 </data>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
27 </outputs>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
28 <tests>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
29 <test>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
30 <param name="input_file" value="picard_input_sorted_pair.sam" />
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
31 <param name="sortOrder" value="coordinate" />
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
32 <param name="outputFormat" value="True" />
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
33 <param name="out_prefix" value="Test FixMate" />
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
34 <output name="out_file" file="picard_output_fixmate_sorted_pair.bam" ftype="bam" />
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
35 </test>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
36 <test>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
37 <param name="input_file" value="picard_input_sorted_pair.sam" />
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
38 <param name="sortOrder" value="coordinate" />
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
39 <param name="outputFormat" value="False" />
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
40 <param name="out_prefix" value="Test FixMate" />
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
41 <output name="out_file" file="picard_output_fixmate_sorted_pair.sam" ftype="sam" />
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
42 </test>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
43 </tests>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
44 <help>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
45
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
46
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
47 .. class:: infomark
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
48
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
49 **Purpose**
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
50
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
51 Ensure that all mate-pair information is in sync between each read and it's mate pair.
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
52
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
53 **Picard documentation**
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
54
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
55 This is a Galaxy wrapper for FixMateInformation, a part of the external package Picard-tools_.
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
56
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
57 .. _Picard-tools: http://www.google.com/search?q=picard+samtools
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
58
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
59 .. class:: warningmark
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
60
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
61 **Useful for paired data only**
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
62
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
63 Likely won't do anything helpful for single end sequence data
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
64 Currently, Galaxy doesn't distinguish paired from single ended SAM/BAM so make sure
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
65 the data you choose are valid (paired end) SAM or BAM data - unless you trust this
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
66 tool not to harm your data.
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
67
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
68 -----
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
69
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
70 .. class:: infomark
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
71
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
72 **Syntax**
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
73
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
74 - **Input** - a paired read sam/bam format aligned short read data in your current history
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
75 - **Sort order** - can be used to adjust the ordering of reads
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
76 - **Title** - the title to use for all output files from this job - use it for high level metadata
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
77 - **Output Format** - either SAM or compressed as BAM
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
78
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
79 -----
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
80
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
81 .. class:: infomark
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
82
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
83 **Inputs, outputs, and parameters**
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
84
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
85 .. csv-table::
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
86
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
87 :header-rows: 1
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
88
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
89 Option,Description
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
90 "INPUT=File","The input file to fix. This option may be specified 0 or more times."
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
91 "OUTPUT=File","The output file to write to"
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
92 "SORT_ORDER=SortOrder","Optional sort order if the OUTPUT file should be sorted differently than the INPUT file. Default value: null. Possible values: {unsorted, queryname, coordinate}"
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
93 "CREATE_MD5_FILE=Boolean","Whether to create an MD5 digest for any BAM files created. Default value: false"
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
94
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
95 .. class:: warningmark
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
96
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
97 **Warning on SAM/BAM quality**
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
98
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
99 Many SAM/BAM files produced externally and uploaded to Galaxy do not fully conform to SAM/BAM specifications. Galaxy deals with this by using the **LENIENT**
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
100 flag when it runs Picard, which allows reads to be discarded if they're empty or don't map. This appears
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
101 to be the only way to deal with SAM/BAM that cannot be parsed.
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
102
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
103
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
104 </help>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
105 </tool>
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
106
ae3d9a7c8399 Uploaded
devteam
parents:
diff changeset
107