annotate picard_ReorderSam.xml @ 1:5f1da1eadb39 draft default tip

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