Mercurial > repos > devteam > picard
annotate picard_SamToFastq.xml @ 2:9227b8c3093b
Updated command line format per dev team standards.
| author | devteam <devteam@galaxyproject.org> |
|---|---|
| date | Tue, 02 Apr 2013 09:42:36 -0400 |
| parents | 1cd7f3b42609 |
| children | 3d4f1fa26f0e |
| rev | line source |
|---|---|
| 0 | 1 <tool id="picard_SamToFastq" name="SAM to FASTQ" version="1.56.1" force_history_refresh="True"> |
| 2 <description>creates a FASTQ file</description> | |
| 3 <requirements><requirement type="package" version="1.56.0">picard</requirement></requirements> | |
| 4 <!-- Dan Blankenberg --> | |
| 5 <command interpreter="python">picard_SamToFastq_wrapper.py | |
| 6 -p ' | |
| 7 java -XX:DefaultMaxRAMFraction=1 -XX:+UseParallelGC | |
| 8 -jar "\$JAVA_JAR_PATH/SamToFastq.jar" | |
| 9 INPUT="${input_sam}" | |
| 10 VALIDATION_STRINGENCY="LENIENT" | |
|
2
9227b8c3093b
Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents:
0
diff
changeset
|
11 RE_REVERSE="${re_reverse}" |
|
9227b8c3093b
Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents:
0
diff
changeset
|
12 INCLUDE_NON_PF_READS="${include_non_pf_reads}" |
| 0 | 13 #if str( $clipping_attribute ): |
| 14 CLIPPING_ATTRIBUTE="${clipping_attribute}" | |
| 15 #end if | |
| 16 #if str( $clipping_action ): | |
| 17 CLIPPING_ACTION="${clipping_action}" | |
| 18 #end if | |
| 19 #if str( $read1_trim ): | |
| 20 READ1_TRIM="${read1_trim}" | |
| 21 #end if | |
| 22 #if str( $read1_max_bases_to_write ): | |
| 23 READ1_MAX_BASES_TO_WRITE="${read1_max_bases_to_write}" | |
| 24 #end if | |
|
2
9227b8c3093b
Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents:
0
diff
changeset
|
25 INCLUDE_NON_PRIMARY_ALIGNMENTS="${include_non_primary_alignments}" |
| 0 | 26 |
| 27 #if str( $output_per_read_group_selector ) == 'per_sam_file': | |
| 28 ##OUTPUT_PER_RG=false | |
| 29 FASTQ="${output_fastq1}" | |
| 30 | |
| 31 #if str( $single_paired_end_type.single_paired_end_type_selector ) == 'paired': | |
| 32 SECOND_END_FASTQ="${output_fastq2}" | |
| 33 #if str( $single_paired_end_type.read2_trim ): | |
| 34 READ2_TRIM="${single_paired_end_type.read2_trim}" | |
| 35 #end if | |
| 36 #if str( $single_paired_end_type.read2_max_bases_to_write ): | |
| 37 READ2_MAX_BASES_TO_WRITE="${single_paired_end_type.read2_max_bases_to_write}" | |
| 38 #end if | |
| 39 #end if | |
| 40 ' | |
| 41 #else: | |
| 42 OUTPUT_PER_RG=true | |
| 43 #if str( $single_paired_end_type.single_paired_end_type_selector ) == 'paired': | |
| 44 ' | |
| 45 --read_group_file_2 "${output_fastq2}" | |
| 46 --file_id_2 "${output_fastq2.id}" | |
| 47 -p ' | |
| 48 #if str( $single_paired_end_type.read2_trim ): | |
| 49 READ2_TRIM="${single_paired_end_type.read2_trim}" | |
| 50 #end if | |
| 51 #if str( $single_paired_end_type.read2_max_bases_to_write ): | |
| 52 READ2_MAX_BASES_TO_WRITE="${single_paired_end_type.read2_max_bases_to_write}" | |
| 53 #end if | |
| 54 #end if | |
| 55 ' | |
| 56 --read_group_file_1 "${output_fastq1}" | |
|
2
9227b8c3093b
Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents:
0
diff
changeset
|
57 --new_files_path "${__new_file_path__}" |
| 0 | 58 --file_id_1 "${output_fastq1.id}" |
| 59 #end if | |
| 60 </command> | |
| 61 <inputs> | |
| 62 <param name="input_sam" type="data" format="sam,bam" label="BAM/SAM file" /> | |
| 63 <param name="read1_trim" type="integer" value="" optional="True" label="The number of bases to trim from the beginning of read 1." /> | |
| 64 <param name="read1_max_bases_to_write" type="integer" optional="True" value="" label="The maximum number of bases to write from read 1 after trimming." /> | |
| 65 <param name="output_per_read_group_selector" type="select" label="Output per read group"> | |
| 66 <option value="per_sam_file" selected="True">Per BAM/SAM file</option> | |
| 67 <option value="per_read_group">Per Read Group</option> | |
| 68 </param> | |
| 69 <conditional name="single_paired_end_type"> | |
| 70 <param name="single_paired_end_type_selector" type="select" label="Single or Paired end"> | |
| 71 <option value="single" selected="True">Single</option> | |
| 72 <option value="paired">Paired end</option> | |
| 73 </param> | |
| 74 <when value="single"> | |
| 75 <!-- nothing yet --> | |
| 76 </when> | |
| 77 <when value="paired"> | |
| 78 <param name="read2_trim" type="integer" value="" optional="True" label="The number of bases to trim from the beginning of read 2." /> | |
| 79 <param name="read2_max_bases_to_write" type="integer" optional="True" value="" label="The maximum number of bases to write from read 2 after trimming." /> | |
| 80 </when> | |
| 81 </conditional> | |
| 82 <param name="re_reverse" type="boolean" truevalue="true" falsevalue="false" checked="True" label="Re-reverse bases and qualities of reads on negative strand"/> | |
| 83 <param name="include_non_pf_reads" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Include non-PF reads from the SAM file into the output FASTQ files."/> | |
| 84 <param name="clipping_attribute" type="text" value="" label="The attribute that stores the position at which the SAM record should be clipped" help="Leave blank for null" /> | |
| 85 <param name="clipping_action" type="text" value="" label="The action that should be taken with clipped reads" help="'X' means the reads and qualities should be trimmed at the clipped position; 'N' means the bases should be changed to Ns in the clipped region; and any integer means that the base qualities should be set to that value in the clipped region. Leave blank for null" /> | |
| 86 <param name="include_non_primary_alignments" type="boolean" truevalue="true" falsevalue="false" checked="False" label="If true, include non-primary alignments in the output." help="Support of non-primary alignments in SamToFastq is not comprehensive, so there may be exceptions if this is set to true and there are paired reads with non-primary alignments."/> | |
| 87 | |
| 88 </inputs> | |
| 89 <outputs> | |
| 90 <data format="fastqsanger" name="output_fastq1" label="${tool.name} on ${on_string}: FASTQ 1" /> | |
| 91 <data format="fastqsanger" name="output_fastq2" label="${tool.name} on ${on_string}: FASTQ 2" > | |
| 92 <filter>single_paired_end_type['single_paired_end_type_selector'] == 'paired'</filter> | |
| 93 </data> | |
| 94 </outputs> | |
| 95 <tests> | |
| 96 <test> | |
| 97 <param name="input_sam" value="bfast_out1.sam" ftype="sam" /> | |
| 98 <param name="output_per_read_group_selector" value="per_sam_file" /> | |
| 99 <param name="single_paired_end_type_selector" value="single" /> | |
| 100 <param name="read1_trim" value="" /> | |
| 101 <param name="read1_max_bases_to_write" value="" /> | |
| 102 <param name="re_reverse" value="True" /> | |
| 103 <param name="include_non_pf_reads" value="False" /> | |
| 104 <param name="clipping_action" value="" /> | |
| 105 <param name="clipping_attribute" value="" /> | |
| 106 <param name="include_non_primary_alignments" value="False" /> | |
| 107 <output name="output_fastq1" file="random_phiX_1.fastqsanger"/> | |
| 108 </test> | |
| 109 <test> | |
| 110 <param name="input_sam" value="bwa_wrapper_out3.sam" ftype="sam" /> | |
| 111 <param name="output_per_read_group_selector" value="per_sam_file" /> | |
| 112 <param name="single_paired_end_type_selector" value="paired" /> | |
| 113 <param name="read1_trim" value="" /> | |
| 114 <param name="read1_max_bases_to_write" value="" /> | |
| 115 <param name="read2_trim" value="" /> | |
| 116 <param name="read2_max_bases_to_write" value="" /> | |
| 117 <param name="re_reverse" value="True" /> | |
| 118 <param name="include_non_pf_reads" value="False" /> | |
| 119 <param name="clipping_action" value="" /> | |
| 120 <param name="clipping_attribute" value="" /> | |
| 121 <param name="include_non_primary_alignments" value="False" /> | |
| 122 <output name="output_fastq1" file="bwa_wrapper_in2.fastqsanger" lines_diff="64"/> <!-- 16 unaligned fastq blocks not present in original sam file --> | |
| 123 <output name="output_fastq2" file="bwa_wrapper_in3.fastqsanger" lines_diff="64"/> <!-- 16 unaligned fastq blocks not present in original sam file --> | |
| 124 </test> | |
| 125 <test> | |
| 126 <param name="input_sam" value="bwa_wrapper_out3.sam" ftype="sam" /> | |
| 127 <param name="output_per_read_group_selector" value="per_read_group" /> | |
| 128 <param name="single_paired_end_type_selector" value="paired" /> | |
| 129 <param name="read1_trim" value="" /> | |
| 130 <param name="read1_max_bases_to_write" value="" /> | |
| 131 <param name="read2_trim" value="" /> | |
| 132 <param name="read2_max_bases_to_write" value="" /> | |
| 133 <param name="re_reverse" value="True" /> | |
| 134 <param name="include_non_pf_reads" value="False" /> | |
| 135 <param name="clipping_action" value="" /> | |
| 136 <param name="clipping_attribute" value="" /> | |
| 137 <param name="include_non_primary_alignments" value="False" /> | |
| 138 <output name="output_fastq1" file="bwa_wrapper_in2.fastqsanger" lines_diff="64"/> <!-- 16 unaligned fastq blocks not present in original sam file --> | |
| 139 <output name="output_fastq2" file="bwa_wrapper_in3.fastqsanger" lines_diff="64"/> <!-- 16 unaligned fastq blocks not present in original sam file --> | |
| 140 </test> | |
| 141 </tests> | |
| 142 <help> | |
| 143 **What it does** | |
| 144 | |
| 145 Picard: SamToFastq converts SAM files to FASTQ files. | |
| 146 | |
| 147 Extracts read sequences and qualities from the input SAM/BAM file and writes them into the output file in Sanger fastq format. In the RC mode (default is True), if the read is aligned and the alignment is to the reverse strand on the genome, the read's sequence from input SAM file will be reverse-complemented prior to writing it to fastq in order restore correctly the original read sequence as it was generated by the sequencer. | |
| 148 | |
| 149 ------ | |
| 150 | |
| 151 Please cite the website "http://picard.sourceforge.net". | |
| 152 | |
| 153 ------ | |
| 154 | |
| 155 | |
| 156 **Input formats** | |
| 157 | |
| 158 FastqToSam accepts SAM input files, see http://samtools.sourceforge.net for more details. | |
| 159 | |
| 160 ------ | |
| 161 | |
| 162 **Outputs** | |
| 163 | |
| 164 The output is in FASTQ format. If using Paired end data, 2 fastq files are created. | |
| 165 | |
| 166 ------- | |
| 167 | |
| 168 **FastqToSam settings** | |
| 169 | |
| 170 This is list of SamToFastq options:: | |
| 171 | |
| 172 INPUT=File Input SAM/BAM file to extract reads from Required. | |
| 173 FASTQ=File Output fastq file (single-end fastq or, if paired, first end of the pair fastq). Required. Cannot be used in conjuction with option(s) OUTPUT_PER_RG (OPRG) | |
| 174 SECOND_END_FASTQ=File Output fastq file (if paired, second end of the pair fastq). Default value: null. Cannot be used in conjuction with option(s) OUTPUT_PER_RG (OPRG) | |
| 175 OUTPUT_PER_RG=Boolean Output a fastq file per read group (two fastq files per read group if the group is paired). Default value: false. This option can be set to 'null' to clear the default value. Possible values: {true, false} Cannot be used in conjuction with option(s) SECOND_END_FASTQ (F2) FASTQ (F) | |
| 176 OUTPUT_DIR=File Directory in which to output the fastq file(s). Used only when OUTPUT_PER_RG is true. Default value: null. | |
| 177 RE_REVERSE=Boolean Re-reverse bases and qualities of reads with negative strand flag set before writing them to fastq Default value: true. This option can be set to 'null' to clear the default value. Possible values: {true, false} | |
| 178 INCLUDE_NON_PF_READS=Boolean Include non-PF reads from the SAM file into the output FASTQ files. Default value: false. This option can be set to 'null' to clear the default value. Possible values: {true, false} | |
| 179 CLIPPING_ATTRIBUTE=String The attribute that stores the position at which the SAM record should be clipped Default value: null. | |
| 180 CLIPPING_ACTION=String The action that should be taken with clipped reads: 'X' means the reads and qualities should be trimmed at the clipped position; 'N' means the bases should be changed to Ns in the clipped region; and any integer means that the base qualities should be set to that value in the clipped region. Default value: null. | |
| 181 READ1_TRIM=Integer The number of bases to trim from the beginning of read 1. Default value: 0. This option can be set to 'null' to clear the default value. | |
| 182 READ1_MAX_BASES_TO_WRITE=Integer The maximum number of bases to write from read 1 after trimming. If there are fewer than this many bases left after trimming, all will be written. If this value is null then all bases left after trimming will be written. Default value: null. | |
| 183 READ2_TRIM=Integer The number of bases to trim from the beginning of read 2. Default value: 0. This option can be set to 'null' to clear the default value. | |
| 184 READ2_MAX_BASES_TO_WRITE=Integer The maximum number of bases to write from read 2 after trimming. If there are fewer than this many bases left after trimming, all will be written. If this value is null then all bases left after trimming will be written. Default value: null. | |
| 185 INCLUDE_NON_PRIMARY_ALIGNMENTS=Boolean If true, include non-primary alignments in the output. Support of non-primary alignments in SamToFastq is not comprehensive, so there may be exceptions if this is set to true and there are paired reads with non-primary alignments. Default value: false. This option can be set to 'null' to clear the default value. Possible values: {true, false} | |
| 186 | |
| 187 | |
| 188 </help> | |
| 189 </tool> |