comparison picard_MeanQualityByCycle.xml @ 5:3d4f1fa26f0e draft

Uploaded
author devteam
date Tue, 16 Dec 2014 19:03:21 -0500
parents
children 3a3234d7a2e8
comparison
equal deleted inserted replaced
4:ab1f60c26526 5:3d4f1fa26f0e
1 <tool name="MeanQualityByCycle" id="picard_MeanQualityByCycle" version="1.126.0">
2 <description>chart distribution of base qualities</description>
3 <requirements>
4 <requirement type="package" version="1.126.0">picard</requirement>
5 </requirements>
6
7 <macros>
8 <import>picard_macros.xml</import>
9 </macros>
10
11 <command>
12 @java_options@
13 ##set up input files
14
15 #set $reference_fasta_filename = "localref.fa"
16
17 #if str( $reference_source.reference_source_selector ) == "history":
18 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" &amp;&amp;
19 #else:
20 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
21 #end if
22
23 java -jar \$JAVA_JAR_PATH/picard.jar
24 MeanQualityByCycle
25 INPUT="${inputFile}"
26 OUTPUT="${outFile}"
27 CHART_OUTPUT="${pdfFile}"
28 REFERENCE_SEQUENCE="${reference_fasta_filename}"
29 ALIGNED_READS_ONLY="${aligned_reads_only}"
30 PF_READS_ONLY="${pf_reads_only}"
31
32 ASSUME_SORTED="${assume_sorted}"
33
34 VALIDATION_STRINGENCY="${validation_stringency}"
35 QUIET=true
36 VERBOSITY=ERROR
37
38 </command>
39 <inputs>
40 <param format="sam,bam" name="inputFile" type="data" label="SAM/BAM dataset or dataset collection" help="If empty, upload or import a SAM/BAM dataset."/>
41 <conditional name="reference_source">
42 <param name="reference_source_selector" type="select" label="Load reference genome from">
43 <option value="cached">Local cache</option>
44 <option value="history">History</option>
45 </param>
46 <when value="cached">
47 <param name="ref_file" type="select" label="Using reference genome" help="REFERENCE_SEQUENCE">
48 <options from_data_table="all_fasta">
49 </options>
50 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
51 </param>
52 </when>
53 <when value="history">
54 <param name="ref_file" type="data" format="fasta" label="Use the folloing dataset as the reference sequence" help="REFERENCE_SEQUENCE; You can upload a FASTA sequence to the history and use it as reference" />
55 </when>
56 </conditional>
57 <param name="aligned_reads_only" type="boolean" truevalue="true" falsevalue="false" label="If set to true, calculate mean quality over aligned reads only" help="ALIGNED_READS_ONLY; default=False"/>
58 <param name="pf_reads_only" type="boolean" truevalue="true" falsevalue="false" label="If set to true calculate mean quality over reads passing quality filter" help="PF_READS_ONLY; default=False"/>
59 <param name="assume_sorted" type="boolean" label="Assume the input file is already sorted" checked="true" truevalue="true" falsevalue="false" help="ASSUME_SORTED"/>
60
61 <expand macro="VS" />
62
63 </inputs>
64
65 <outputs>
66 <data format="tabular" name="outFile" label="${tool.name} on ${on_string}: Summary data"/>
67 <data format="pdf" name="pdfFile" label="${tool.name} on ${on_string}: Chart PDF"/>
68 </outputs>
69
70 <tests>
71 <test>
72 <param name="assume_sorted" value="true" />
73 <param name="aligned_reads_only" value="false" />
74 <param name="pf_reads_only" value="false" />
75 <param name="reference_source_selector" value="history" />
76 <param name="ref_file" value="picard_MeanQualityByCycle_ref.fa" />
77 <param name="inputFile" value="picard_MeanQualityByCycle.bam" ftype="bam" />
78 <output name="outFile" file="picard_MeanQualityByCycle_test1.tab" ftype="tabular" lines_diff="4"/>
79 </test>
80 </tests>
81
82 <stdio>
83 <exit_code range="1:" level="fatal"/>
84 </stdio>
85
86 <help>
87
88 .. class:: infomark
89
90 **Purpose**
91
92 Program to chart the distribution of base qualities by cycle within reads supplied in a SAM or BAM dataset.
93
94 @dataset_collections@
95
96 @description@
97
98 ALIGNED_READS_ONLY=Boolean If set to true, calculate the base distribution over aligned reads only. Default value:
99 false. Possible values: {true, false}
100
101 PF_READS_ONLY=Boolean If set to true calculate the base distribution over PF reads only. Default value: false.
102 This option can be set to 'null' to clear the default value. Possible values: {true,
103 false}
104
105 ASSUME_SORTED=Boolean
106 AS=Boolean If true (default), then the sort order in the header file will be ignored. Default: True
107
108 @more_info@
109
110 </help>
111 </tool>
112
113