annotate picard_MeanQualityByCycle.xml @ 1:5f1da1eadb39 draft default tip

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