Mercurial > repos > devteam > picard

comparison picard_CollectBaseDistributionByCycle.xml @ 5:3d4f1fa26f0e draft

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