annotate picard_FastqToSam.xml @ 1:e0232cbac965

Uploaded
author devteam
date Thu, 25 Oct 2012 12:51:42 -0400
parents 1cd7f3b42609
children bf1c3f9f8282
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
1 <tool id="picard_FastqToSam" name="FASTQ to BAM" version="1.56.0">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
2 <description>creates an unaligned BAM file</description>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
3 <requirements><requirement type="package" version="1.56.0">picard</requirement></requirements>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
4 <!-- Dan Blankenberg -->
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
5 <command>java -XX:DefaultMaxRAMFraction=1 -XX:+UseParallelGC
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
6 -jar "\$JAVA_JAR_PATH/FastqToSam.jar"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
7 FASTQ="${input_fastq1}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
8 #if str( $input_fastq2) != "None":
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
9 FASTQ2="${input_fastq2}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
10 #end if
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
11 QUALITY_FORMAT="${ dict( fastqsanger='Standard', fastqcssanger='Standard', fastqillumina='Illumina', fastqsolexa='Solexa' )[ $input_fastq1.ext ] }" ##Solexa, Illumina, Standard
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
12 OUTPUT="${output_bam}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
13 READ_GROUP_NAME="${read_group_name}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
14 SAMPLE_NAME="${sample_name}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
15 #if $param_type.param_type_selector == "advanced":
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
16 #if str( $param_type.library_name ) != "":
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
17 LIBRARY_NAME="${param_type.library_name}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
18 #end if
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
19 #if str( $param_type.platform_unit ) != "":
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
20 PLATFORM_UNIT="${param_type.platform_unit}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
21 #end if
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
22 #if str( $param_type.platform ) != "":
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
23 PLATFORM="${param_type.platform}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
24 #end if
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
25 #if str( $param_type.sequencing_center ) != "":
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
26 SEQUENCING_CENTER="${param_type.sequencing_center}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
27 #end if
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
28 #if str( $param_type.predicted_insert_size ) != "":
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
29 PREDICTED_INSERT_SIZE="${param_type.predicted_insert_size}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
30 #end if
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
31 #if str( $param_type.description.value ) != "":
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
32 DESCRIPTION="${param_type.description}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
33 #end if
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
34 #if str( $param_type.run_date ) != "":
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
35 RUN_DATE="${param_type.run_date}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
36 #end if
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
37 #if str( $param_type.min_q ) != "":
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
38 MIN_Q="${param_type.min_q}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
39 #end if
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
40 #if str( $param_type.min_q ) != "":
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
41 MAX_Q="${param_type.max_q}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
42 #end if
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
43 SORT_ORDER="${param_type.sort_order}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
44 #else:
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
45 SORT_ORDER=coordinate ##unsorted, queryname, coordinate; always use coordinate
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
46 #end if
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
47 2&gt;&amp;1
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
48 || echo "Error running Picard FastqToSAM" >&amp;2
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
49 </command>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
50 <inputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
51 <param name="input_fastq1" type="data" format="fastqsanger,fastqillumina,fastqsolexa,fastqcssanger" label="FASTQ file" /> <!-- confirm that fastqcssanger also works -->
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
52 <param name="input_fastq2" type="data" format="fastqsanger,fastqillumina,fastqsolexa,fastqcssanger" optional="True" label="Second FASTQ of paired end data" help="Only needed when using paired end data." >
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
53 <options options_filter_attribute="ext" from_parameter="tool.app.datatypes_registry.datatypes_by_extension" transform_lines="obj.keys()">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
54 <column name="name" index="0"/>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
55 <column name="value" index="0"/>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
56 <filter type="param_value" ref="input_fastq1" ref_attribute="ext" column="0"/>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
57 </options>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
58 </param>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
59 <param name="read_group_name" type="text" value="A" label="Read Group Name" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
60 <param name="sample_name" type="text" value="unknown sample" label="Sample Name" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
61 <conditional name="param_type">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
62 <param name="param_type_selector" type="select" label="Basic or Advanced options">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
63 <option value="basic" selected="True">Basic</option>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
64 <option value="advanced">Advanced</option>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
65 </param>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
66 <when value="basic">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
67 <!-- Do nothing here -->
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
68 </when>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
69 <when value="advanced">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
70 <param name="library_name" type="text" value="" label="Library Name" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
71 <param name="platform_unit" type="text" value="" label="Platform Unit" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
72 <param name="platform" type="text" value="" label="Platform" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
73 <param name="sequencing_center" type="text" value="" label="Sequencing Center" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
74 <param name="predicted_insert_size" type="integer" value="" optional="True" label="Predicted Insert Size" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
75 <param name="description" type="text" value="" label="Description" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
76 <param name="run_date" type="text" value="" label="Run Date" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
77 <param name="min_q" type="integer" optional="True" value="0" label="Min Q" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
78 <param name="max_q" type="integer" optional="True" value="93" label="Max Q" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
79 <param name="sort_order" type="select" label="Sort order">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
80 <option value="coordinate" selected="True">coordinate</option>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
81 <option value="queryname">queryname</option>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
82 <option value="unsorted">unsorted</option>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
83 </param>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
84 </when>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
85 </conditional>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
86 </inputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
87 <outputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
88 <data format="bam" name="output_bam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
89 </outputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
90 <tests>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
91 <test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
92 <param name="input_fastq1" value="bwa_wrapper_in2.fastqsanger" ftype="fastqsanger" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
93 <param name="input_fastq2" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
94 <param name="read_group_name" value="A" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
95 <param name="sample_name" value="unknown sample" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
96 <param name="param_type_selector" value="basic" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
97 <output name="output_bam" file="picard_fastq_to_sam_out1.bam" ftype="bam"/>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
98 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
99 <test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
100 <param name="input_fastq1" value="bwa_wrapper_in2.fastqsanger" ftype="fastqsanger" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
101 <param name="input_fastq2" value="bwa_wrapper_in3.fastqsanger" ftype="fastqsanger" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
102 <param name="read_group_name" value="A" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
103 <param name="sample_name" value="unknown sample" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
104 <param name="param_type_selector" value="basic" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
105 <output name="output_bam" file="picard_fastq_to_sam_out2.bam" ftype="bam"/>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
106 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
107 </tests>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
108 <help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
109 **What it does**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
110
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
111 Picard: FastqToSam converts FASTQ files to unaligned BAM files.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
112
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
113 ------
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
114
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
115 Please cite the website "http://picard.sourceforge.net".
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
116
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
117 ------
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
118
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
119
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
120 **Input formats**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
121
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
122 FastqToSam accepts FASTQ input files. If using paired-end data, you should select two FASTQ files.
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 **Outputs**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
127
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
128 The output is in BAM format, see http://samtools.sourceforge.net for more details.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
129
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
130 -------
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
131
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
132 **FastqToSam settings**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
133
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
134 This is list of FastqToSam options::
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
135
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
136 READ_GROUP_NAME=String Read group name Default value: A. This option can be set to 'null' to clear the default value.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
137 SAMPLE_NAME=String Sample name to insert into the read group header Required.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
138 LIBRARY_NAME=String The library name to place into the LB attribute in the read group header Default value: null.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
139 PLATFORM_UNIT=String The platform unit (often run_barcode.lane) to insert into the read group header Default value: null.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
140 PLATFORM=String The platform type (e.g. illumina, solid) to insert into the read group header Default value: null.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
141 SEQUENCING_CENTER=String The sequencing center from which the data originated Default value: null.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
142 PREDICTED_INSERT_SIZE=Integer Predicted median insert size, to insert into the read group header Default value: null.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
143 DESCRIPTION=String Inserted into the read group header Default value: null.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
144 </help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
145 </tool>