annotate picard_MeanQualityByCycle.xml @ 6:4ff1e04010e6 draft

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