annotate picard_ReorderSam.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: 2
diff changeset
1 <tool name="ReorderSam" id="picard_ReorderSam" version="1.126.0">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
2 <description>reorder reads to match ordering in reference sequences</description>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
3 <requirements><requirement type="package" version="1.126.0">picard</requirement></requirements>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
4
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
5 <macros>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
6 <import>picard_macros.xml</import>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
7 </macros>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
8
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
9 <command>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
10 @java_options@
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
11 #set $picard_dict = "localref.dict"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
12 #set $ref_fasta = "localref.fa" ## This is done because picards "likes" .fa extension
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
13
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
14 ln -s "${reference_source.ref_file}" "${ref_fasta}" &amp;&amp;
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
15
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
16 #if str( $reference_source.reference_source_selector ) == "history":
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
17
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
18 java -jar \$JAVA_JAR_PATH/picard.jar CreateSequenceDictionary REFERENCE="${ref_fasta}" OUTPUT="${picard_dict}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
19 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
20 VERBOSITY=ERROR
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
21
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
22 &amp;&amp;
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
23
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
24 #else:
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
25
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
26 #set $ref_fasta = str( $reference_source.ref_file.fields.path )
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
27
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
28 #end if
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
29
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
30 java -jar \$JAVA_JAR_PATH/picard.jar
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
31 ReorderSam
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
32 INPUT="${inputFile}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
33 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
34 REFERENCE="${ref_fasta}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
35 ALLOW_INCOMPLETE_DICT_CONCORDANCE="${allow_incomplete_dict_concordance}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
36 ALLOW_CONTIG_LENGTH_DISCORDANCE="${allow_contig_length_discordance}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
37
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
38 VALIDATION_STRINGENCY="${validation_stringency}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
39 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
40 VERBOSITY=ERROR
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
41
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
42 </command>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
43
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
44 <inputs>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
45
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
46 <conditional name="reference_source">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
47 <param name="reference_source_selector" type="select" label="Load reference genome from">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
48 <option value="cached">Local cache</option>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
49 <option value="history">History</option>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
50 </param>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
51 <when value="cached">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
52 <param name="ref_file" type="select" label="Use dictionary from the list" help="Select genome from the list">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
53 <options from_data_table="picard_indexes">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
54 <filter type="sort_by" column="2" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
55 <validator type="no_options" message="No indexes are available" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
56 </options>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
57 <validator type="no_options" message="A built-in dictionary is not available for the build associated with the selected input file"/>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
58 </param>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
59 </when>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
60 <when value="history">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
61 <param name="ref_file" type="data" format="fasta" label="Use the following dataset to create dictionary" help="You can upload a FASTA sequence to the history from which Picard will automatically generate dictionary using CreateSequenceDictionary command" />
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
62 </when>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
63 </conditional>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
64
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
65 <param format="sam,bam" name="inputFile" type="data" label="Select SAM/BAM dataset or dataset collection" help="If empty, upload or import a SAM/BAM dataset"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
66 <param name="allow_incomplete_dict_concordance" type="boolean" label="If true, then allows only a partial overlap of the BAM contigs with the new reference sequence contigs" help="ALLOW_INCOMPLETE_DICT_CONCORDANCE; By default, this tool requires a corresponding contig in the new reference for each read contig; default=False"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
67 <param name="allow_contig_length_discordance" type="boolean" label="If true, then permits mapping from a read contig to a new reference contig with the same name but a different length" help="ALLOW_CONTIG_LENGTH_DISCORDANCE; HIGHLY DANGEROUS! Only use if you know what you are doing; default=False"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
68 <expand macro="VS" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
69
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
70 </inputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
71 <outputs>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
72 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: Reordered BAM"/>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
73 </outputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
74 <tests>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
75 <test>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
76 <param name="reference_source_selector" value="history" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
77 <param name="ref_file" value="picard_ReorderSam_ref.fa" ftype="fasta" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
78 <param name="inputFile" value="picard_ReorderSam.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
79 <param name="allow_incomplete_dict_concordance" value="false"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
80 <param name="allow_contig_length_discordance" value="false"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
81 <output name="outFile" file="picard_ReorderSam_test1.bam" ftype="bam" lines_diff="2"/>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
82 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
83 </tests>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
84
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
85 <stdio>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
86 <exit_code range="1:" level="fatal"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
87 </stdio>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
88
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
89 <help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
90
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
91 .. class:: infomark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
92
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
93 **Purpose**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
94
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
95 ReorderSam reorders reads in a SAM/BAM file to match the contig ordering in a provided reference file, as determined by exact name matching of contigs. Reads mapped to contigs absent in the new reference are dropped.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
96
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
97 @dataset_collections@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
98
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
99 ----
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
100
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
101 .. class:: warningmark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
102
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
103 Not to be confused with **SortSam**.
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
104
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
105 @description@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
106
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
107 ALLOW_INCOMPLETE_DICT_CONCORDANCE=Boolean
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
108 S=Boolean If true, then allows only a partial overlap of the BAM contigs with the new reference
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
109 sequence contigs. By default, this tool requires a corresponding contig in the new
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
110 reference for each read contig Default value: false. Possible values: {true, false}
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
111
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
112 ALLOW_CONTIG_LENGTH_DISCORDANCE=Boolean
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
113 U=Boolean If true, then permits mapping from a read contig to a new reference contig with the same
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
114 name but a different length. Highly dangerous, only use if you know what you are doing.
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
115 Default value: false. Possible values: {true, false}
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
116
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
117 @more_info@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
118 </help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
119 </tool>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
120
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
121
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
122
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
123
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
124
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
125
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
126
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
127
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
128
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
129
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
130
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
131
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
132