annotate picard_CollectBaseDistributionByCycle.xml @ 8:3a3234d7a2e8 draft

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