Mercurial > repos > devteam > picard_122_up

comparison picard_CollectBaseDistributionByCycle.xml @ 0:b76a4f17bbbb draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author devteam
date Thu, 23 Oct 2014 11:31:30 -0400
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:b76a4f17bbbb
1 <tool name="CollectBaseDistributionByCycle" id="picard_CollectBaseDistributionByCycle" version="1.122.0">
2 <description>charts the nucleotide distribution per cycle in a SAM or BAM dataset</description>
3 <requirements>
4 <requirement type="package" version="1.122.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/CollectBaseDistributionByCycle.jar
24 INPUT="${inputFile}"
25 OUTPUT="${outFile}"
26 CHART_OUTPUT="${pdfFile}"
27 ALIGNED_READS_ONLY="${aligned_reads_only}"
28 PF_READS_ONLY="${pf_reads_only}"
29 REFERENCE_SEQUENCE="${reference_fasta_filename}"
30 ASSUME_SORTED="${assume_sorted}"
31
32 VALIDATION_STRINGENCY="${validation_stringency}"
33 QUIET=true
34 VERBOSITY=ERROR
35
36 </command>
37 <inputs>
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."/>
39 <conditional name="reference_source">
40 <param name="reference_source_selector" type="select" label="Load reference genome from">
41 <option value="cached">Local cache</option>
42 <option value="history">History</option>
43 </param>
44 <when value="cached">
45 <param name="ref_file" type="select" label="Using reference genome" help="REFERENCE_SEQUENCE">
46 <options from_data_table="all_fasta">
47 </options>
48 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
49 </param>
50 </when>
51 <when value="history">
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" />
53 </when>
54 </conditional>
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"/>
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"/>
57 <param name="assume_sorted" type="boolean" label="Assume the input file is already sorted" checked="true" truevalue="true" falsevalue="false" help="ASSUME_SORTED"/>
58
59 <expand macro="VS" />
60
61 </inputs>
62
63 <outputs>
64 <data format="tabular" name="outFile"/>
65 <data format="pdf" name="pdfFile"/>
66 </outputs>
67
68 <tests>
69 <test>
70 <param name="aligned_reads_only" value="true" />
71 <param name="pf_reads_only" value="true" />
72 <param name="assume_sorted" value="true" />
73 <param name="reference_source_selector" value="history" />
74 <param name="ref_file" value="picard_CollectBaseDistributionByCycle_ref.fa" />
75 <param name="inputFile" value="picard_CollectBaseDistributionByCycle.bam" ftype="bam" />
76 <output name="outFile" file="picard_CollectBaseDistributionByCycle_test1.tab" ftype="tabular" lines_diff="4"/>
77 </test>
78 </tests>
79
80 <stdio>
81 <exit_code range="1:" level="fatal"/>
82 </stdio>
83
84 <help>
85
86 .. class:: infomark
87
88 **Purpose**
89
90 Program to chart the nucleotide distribution per cycle in a SAM or BAM file.
91
92 @dataset_collections@
93
94 @description@
95
96 ALIGNED_READS_ONLY=Boolean If set to true, calculate the base distribution over aligned reads only. Default value:
97 false. This option can be set to 'null' to clear the default value. Possible values:
98 {true, false}
99
100 PF_READS_ONLY=Boolean If set to true calculate the base distribution over PF reads only. Default value: false.
101 This option can be set to 'null' to clear the default value. Possible values: {true,
102 false}
103
104 REFERENCE_SEQUENCE=File
105 R=File Reference sequence fasta Default value: null.
106
107 ASSUME_SORTED=Boolean
108 AS=Boolean If true (default), then the sort order in the header file will be ignored. Default
109
110 @more_info@
111
112 </help>
113 </tool>
114
115