annotate picard_CollectBaseDistributionByCycle.xml @ 0:b76a4f17bbbb draft

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