annotate picard_CollectBaseDistributionByCycle.xml @ 28:881d7645d1bf draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 92e89c89178482870c14cf15f38fbfd4470aa130"
author iuc
date Sat, 15 Jan 2022 12:39:30 +0000
parents 2a17c789e0a5
children 585027e65f3b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 14
diff changeset
1 <tool name="CollectBaseDistributionByCycle" id="picard_CollectBaseDistributionByCycle" version="@TOOL_VERSION@.@WRAPPER_VERSION@">
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>
20
2a17c789e0a5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 5ebd6c8453b49dd6a36e372eb1eb6e323bb7ad8a
iuc
parents: 19
diff changeset
5 <token name="@WRAPPER_VERSION@">1</token>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
6 </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
7 <expand macro="requirements">
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 14
diff changeset
8 <requirement type="package" version="3.4.1">r-base</requirement>
8
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
9 </expand>
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
11 @java_options@
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
12 @symlink_element_identifier@
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
13 ##set up input files
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
14
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
15 #set $reference_fasta_filename = "localref.fa"
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
16
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 14
diff changeset
17 @handle_reference_source@
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
18
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
19 picard
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
20 CollectBaseDistributionByCycle
14
465cbb0cf2eb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
devteam
parents: 13
diff changeset
21 INPUT='$escaped_element_identifier'
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
22 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
23 CHART_OUTPUT="${pdfFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
24 ALIGNED_READS_ONLY="${aligned_reads_only}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
25 PF_READS_ONLY="${pf_reads_only}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
26 REFERENCE_SEQUENCE="${reference_fasta_filename}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
27 ASSUME_SORTED="${assume_sorted}"
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
28
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
29 VALIDATION_STRINGENCY="${validation_stringency}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
30 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
31 VERBOSITY=ERROR
20
2a17c789e0a5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 5ebd6c8453b49dd6a36e372eb1eb6e323bb7ad8a
iuc
parents: 19
diff changeset
32 @TMPDIR_OPTION@
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
33
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
34 ]]></command>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
35 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
36 <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
37 <conditional name="reference_source">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 <param name="reference_source_selector" type="select" label="Load reference genome from">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39 <option value="cached">Local cache</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
40 <option value="history">History</option>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
41 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42 <when value="cached">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43 <param name="ref_file" type="select" label="Using reference genome" help="REFERENCE_SEQUENCE">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
44 <options from_data_table="all_fasta">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
45 </options>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46 <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
47 </param>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48 </when>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
49 <when value="history">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50 <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
51 </when>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52 </conditional>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
53 <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"/>
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
54 <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"/>
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
55 <param name="assume_sorted" type="boolean" label="Assume the input file is already sorted" checked="true" truevalue="true" falsevalue="false" help="ASSUME_SORTED"/>
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
56
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
57 <expand macro="VS" />
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
58
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
59 </inputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
60
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
62 <data format="tabular" name="outFile"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63 <data format="pdf" name="pdfFile"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
64 </outputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
65
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
66 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
67 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
68 <param name="aligned_reads_only" value="true" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
69 <param name="pf_reads_only" value="true" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
70 <param name="assume_sorted" value="true" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
71 <param name="reference_source_selector" value="history" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
72 <param name="ref_file" value="picard_CollectBaseDistributionByCycle_ref.fa" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
73 <param name="inputFile" value="picard_CollectBaseDistributionByCycle.bam" ftype="bam" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
74 <output name="outFile" file="picard_CollectBaseDistributionByCycle_test1.tab" ftype="tabular" lines_diff="4"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
75 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
76 </tests>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
77
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
78
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
79 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
80
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
81 .. class:: infomark
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
82
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
83 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
84
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
85 Program to chart the nucleotide distribution per cycle in a SAM or BAM file.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
86
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
87 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
88
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
89 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
90
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
91 ALIGNED_READS_ONLY=Boolean If set to true, calculate the base distribution over aligned reads only. Default value:
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
92 false. This option can be set to 'null' to clear the default value. Possible values:
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
93 {true, false}
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
94
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
95 PF_READS_ONLY=Boolean If set to true calculate the base distribution over PF reads only. Default value: false.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
96 This option can be set to 'null' to clear the default value. Possible values: {true,
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
97 false}
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
98
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
99 REFERENCE_SEQUENCE=File
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
100 R=File Reference sequence fasta Default value: null.
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
101
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
102 ASSUME_SORTED=Boolean
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
103 AS=Boolean If true (default), then the sort order in the header file will be ignored. Default
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
104
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
105 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
106
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
107 </help>
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 14
diff changeset
108 <expand macro="citations" />
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
109 </tool>