Mercurial > repos > devteam > picard

annotate picard_SamToFastq.xml @ 18:7615ac66c6e5 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 3ce5dea3af8f4816b4a83914b53402aa84e08fca
author iuc
date Sat, 20 Jan 2018 08:28:24 -0500
parents 465cbb0cf2eb
children 5053a18d9bc8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
1 <tool name="SamToFastq" id="picard_SamToFastq" version="@TOOL_VERSION@.0">
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
2 <description>extract reads and qualities from SAM/BAM dataset and convert to fastq</description>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
3 <macros>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
4 <import>picard_macros.xml</import>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
5 </macros>
8
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
6 <expand macro="requirements" />
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
8
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
9 echo "BAM" > $report && ## This is necessary for output dataset detection (see output tags below)
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
10
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
11 @java_options@
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
12 @symlink_element_identifier@
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
13
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
14 picard
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
15 SamToFastq
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
16
14
465cbb0cf2eb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
devteam
parents: 13
diff changeset
17 INPUT='$escaped_element_identifier'
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
18
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
19 #if str( $output_per_rg ) == "true":
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
20 OUTPUT_PER_RG=true
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
21 OUTPUT_DIR=.
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
22 #elif str( $output_per_rg ) == "false" and str( $interleave ) == "false":
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
23 FASTQ=READ1.fastq
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
24 SECOND_END_FASTQ=READ2.fastq
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
25 UNPAIRED_FASTQ=UNPAIRED_READS.fastq
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
26 #elif str( $output_per_rg ) == "false" and str( $interleave ) == "true":
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
27 FASTQ=INTERLEAVED.fastq
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
28 #end if
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
29
2
9227b8c3093b Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
30 RE_REVERSE="${re_reverse}"
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
31 INTERLEAVE="${interleave}"
2
9227b8c3093b Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
32 INCLUDE_NON_PF_READS="${include_non_pf_reads}"
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
33 CLIPPING_ATTRIBUTE="${clipping_attribute}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
34 CLIPPING_ACTION="${clipping_action}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
35 READ1_TRIM="${read1_trim}"
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
36
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
37 #if int($read1_max_bases_to_write) > -1:
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
38 READ1_MAX_BASES_TO_WRITE="${read1_max_bases_to_write}"
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
39 #end if
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
40
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
41 READ2_TRIM="${read2_trim}"
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
42
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
43 #if int($read2_max_bases_to_write) > -1:
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
44 READ2_MAX_BASES_TO_WRITE="${read2_max_bases_to_write}"
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
45 #end if
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
46
2
9227b8c3093b Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
47 INCLUDE_NON_PRIMARY_ALIGNMENTS="${include_non_primary_alignments}"
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
48
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
49
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
50 VALIDATION_STRINGENCY="${validation_stringency}"
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
51 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
52 VERBOSITY=ERROR
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
53
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
54 ]]></command>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
55 <inputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
56
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
57 <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
58 <param name="output_per_rg" type="boolean" checked="False" label="Do you want to output a fastq file per read group (two fastq files per read group if the group is paired)" help="OUTPUT_PER_RG; default=False"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
59 <param name="re_reverse" type="boolean" checked="True" label="Re-reverse bases and qualities of reads with negative strand flag set before writing them to fastq" help="RE_REVERSE; default=True"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
60 <param name="interleave" type="boolean" label="Will generate an interleaved fastq if paired, each line will have /1 or /2 to describe which end it came from" help="INTERLEAVE; default=False"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
61 <param name="include_non_pf_reads" type="boolean" label="Include non-PF reads from the SAM/BAM dataset into the output FASTQ" help="INCLUDE_NON_PF_READS; PF means 'passes filtering'. Reads whose 'not passing quality controls' flag is set are non-PF reads; default=False"/>
9
5eaa8a968300 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents: 8
diff changeset
62 <param name="clipping_attribute" type="text" value="null" label="The attribute that stores the position at which the SAM/BAM record should be clipped" help="CLIPPING_ATTRIBUTE; default=null"/>
5eaa8a968300 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents: 8
diff changeset
63 <param name="clipping_action" type="text" value="null" label="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" help="CLIPPING_ACTION; default=null"/>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
64 <param name="read1_trim" type="integer" value="0" min="0" label="The number of bases to trim from the beginning of read 1" help="READ1_TRIM; default=0"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
65 <param name="read1_max_bases_to_write" type="integer" value="-1" label="The maximum number of bases to write from read 1 after trimming" help="READ1_MAX_BASES_TO_WRITE; 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=null (-1)"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
66 <param name="read2_trim" type="integer" value="0" min="0" label="The number of bases to trim from the beginning of read 2" help="READ2_TRIM; default=0"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
67 <param name="read2_max_bases_to_write" type="integer" value="-1" label="The maximum number of bases to write from read 2 after trimming" help="READ2_MAX_BASES_TO_WRITE; 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=null (-1)"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
68 <param name="include_non_primary_alignments" type="boolean" label="If true, include non-primary alignments in the output" help="INCLUDE_NON_PRIMARY_ALIGNMENTS; 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=False"/>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
69
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
70 <expand macro="VS" />
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
71
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
72 </inputs>
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
73
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
74 <outputs>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
75 <!-- here dataset discovery is based on fact that if OUTPUT_PER_RG=true this tool automatically adds .fastq extension to emitted files -->
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
76 <data format="txt" name="report" label="SamToFastq run" hidden="true">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
77 <discover_datasets pattern="(?P&lt;designation&gt;.+)\.fastq" ext="fastqsanger" visible="true"/>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
78 </data>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
79 </outputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
80
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
81 <tests>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
82 <test>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
83 <param name="inputFile" value="picard_SamToFastq.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
84 <param name="output_per_rg" value="false"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
85 <param name="re_reverse" value="true"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
86 <param name="interleave" value="true"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
87 <param name="include_non_pf_reads" value="false"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
88 <param name="clipping_attribute" value="null" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
89 <param name="clipping_action" value="null" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
90 <param name="read1_trim" value="0" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
91 <param name="read1_max_bases_to_write" value="-1"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
92 <param name="read2_trim" value="0" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
93 <param name="read2_max_bases_to_write" value="-1"/>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
94 <param name="include_non_primary_alignments" value="false"/>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
95 <output name="report">
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
96 <assert_contents>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
97 <has_line line="BAM" />
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
98 </assert_contents>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
99 <discovered_dataset designation="INTERLEAVED" file="picard_SamToFastq_test1.fq" ftype="fastqsanger"/>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
100 </output>
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
101 </test>
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
102 </tests>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
103
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
104
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
105 <help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
106
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
107 **Purpose**
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
108
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
109 Extracts read sequences and qualities from the input SAM/BAM dataset and outputs them in Sanger fastq format. In the RE_REVERSE=True mode (default behavior), if the read is aligned and the alignment is to the reverse strand on the genome, the read's sequence from input SAM.BAM dataset 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.
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
110
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
111 -----
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
112
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
113 .. class:: warningmark
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
114
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
115 **DANGER: Multiple Outputs**
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
116
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
117 Generating per readgroup fastq (setting **OUTPUT_PER_RG** to True) may produce very large numbers of outputs. Know what you are doing!
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
118
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
119 @dataset_collections@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
120
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
121 @description@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
122
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
123 FASTQ=File
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
124 F=File Output fastq file (single-end fastq or, if paired, first end of the pair fastq).
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
125 Required. Cannot be used in conjuction with option(s) OUTPUT_PER_RG (OPRG)
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
126
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
127 SECOND_END_FASTQ=File
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
128 F2=File Output fastq file (if paired, second end of the pair fastq). Default value: null.
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
129 Cannot be used in conjuction with option(s) OUTPUT_PER_RG (OPRG)
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
130
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
131 UNPAIRED_FASTQ=File
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
132 FU=File Output fastq file for unpaired reads; may only be provided in paired-fastq mode Default
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
133 value: null. Cannot be used in conjuction with option(s) OUTPUT_PER_RG (OPRG)
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
134
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
135 OUTPUT_PER_RG=Boolean
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
136 OPRG=Boolean Output a fastq file per read group (two fastq files per read group if the group is
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
137 paired). Default value: false. Possible values: {true, false} Cannot be used in
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
138 conjuction with option(s) SECOND_END_FASTQ (F2) UNPAIRED_FASTQ (FU) FASTQ (F)
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
139
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
140 OUTPUT_DIR=File
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
141 ODIR=File Directory in which to output the fastq file(s). Used only when OUTPUT_PER_RG is true.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
142 Default value: null.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
143
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
144 RE_REVERSE=Boolean
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
145 RC=Boolean Re-reverse bases and qualities of reads with negative strand flag set before writing them
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
146 to fastq Default value: true. Possible values: {true, false}
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
147
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
148 INTERLEAVE=Boolean
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
149 INTER=Boolean Will generate an interleaved fastq if paired, each line will have /1 or /2 to describe
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
150 which end it came from Default value: false. Possible values: {true, false}
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
151
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
152 INCLUDE_NON_PF_READS=Boolean
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
153 NON_PF=Boolean Include non-PF reads from the SAM file into the output FASTQ files. PF means 'passes
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
154 filtering'. Reads whose 'not passing quality controls' flag is set are non-PF reads.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
155 Default value: false. Possible values: {true, false}
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
156
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
157 CLIPPING_ATTRIBUTE=String
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
158 CLIP_ATTR=String The attribute that stores the position at which the SAM record should be clipped Default
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
159 value: null.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
160
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
161 CLIPPING_ACTION=String
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
162 CLIP_ACT=String The action that should be taken with clipped reads: 'X' means the reads and qualities
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
163 should be trimmed at the clipped position; 'N' means the bases should be changed to Ns in
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
164 the clipped region; and any integer means that the base qualities should be set to that
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
165 value in the clipped region. Default value: null.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
166
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
167 READ1_TRIM=Integer
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
168 R1_TRIM=Integer The number of bases to trim from the beginning of read 1. Default value: 0.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
169
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
170 READ1_MAX_BASES_TO_WRITE=Integer
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
171 R1_MAX_BASES=Integer The maximum number of bases to write from read 1 after trimming. If there are fewer than
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
172 this many bases left after trimming, all will be written. If this value is null then all
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
173 bases left after trimming will be written. Default value: null.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
174
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
175 READ2_TRIM=Integer
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
176 R2_TRIM=Integer The number of bases to trim from the beginning of read 2. Default value: 0.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
177
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
178 READ2_MAX_BASES_TO_WRITE=Integer
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
179 R2_MAX_BASES=Integer The maximum number of bases to write from read 2 after trimming. If there are fewer than
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
180 this many bases left after trimming, all will be written. If this value is null then all
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
181 bases left after trimming will be written. Default value: null.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
182
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
183 INCLUDE_NON_PRIMARY_ALIGNMENTS=Boolean
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
184 If true, include non-primary alignments in the output. Support of non-primary alignments
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
185 in SamToFastq is not comprehensive, so there may be exceptions if this is set to true and
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
186 there are paired reads with non-primary alignments. Default value: false.
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
187 Possible values: {true, false}
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
188
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
189 @more_info@
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
190
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
191 </help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
192 </tool>
5
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
193
3d4f1fa26f0e Uploaded
devteam
parents: 2
diff changeset
194