annotate picard_CollectBaseDistributionByCycle.xml @ 33:3f254c5ced1d draft default tip

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