annotate picard_CleanSam.xml @ 32:f9242e01365a draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 285fab1660daa944d6833ae1e059b30cb1e88309
author iuc
date Mon, 25 Sep 2023 08:32:17 +0000
parents 2a17c789e0a5
children 3f254c5ced1d
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 id="picard_CleanSam" name="CleanSam" version="@TOOL_VERSION@.@WRAPPER_VERSION@">
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
2 <description>perform SAM/BAM grooming</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" />
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
9 @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
10 @symlink_element_identifier@
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
11 picard
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
12 CleanSam
14
465cbb0cf2eb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
devteam
parents: 13
diff changeset
13 INPUT='$escaped_element_identifier'
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
14 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
15 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
16 VERBOSITY=ERROR
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
17 VALIDATION_STRINGENCY=${validation_stringency}
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
18 ]]></command>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
19
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
20 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
21 <param name="inputFile" type="data" format="sam,bam" label="Select SAM/BAM dataset or dataset collection" help="If empty, upload or import a SAM/BAM dataset"/>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
22
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
23 <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
24
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
25 </inputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
26
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
27 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
28 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: cleaned BAM dataset">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
29 </data>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
30 </outputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
31
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
32
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
33 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
34 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
35 <param name="inputFile" ftype="bam" value="picard_CleanSam.bam" />
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
36 <output name="outFile" file="picard_CleanSam_test1.bam" ftype="bam" lines_diff="4"/>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
37 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 </tests>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
39
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
40 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
41
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42 .. class:: infomark
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
44 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
45
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46 Read SAM/BAM and perform various fix-ups. Currently, the only fix-ups are:
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48 1. to soft-clip an alignment that hangs off the end of its reference sequence.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
49 2. to set MAPQ to 0 if a read is unmapped.
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
50
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51 @dataset_collections@
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
52
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
54
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
55 </help>
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 14
diff changeset
56 <expand macro="citations" />
8
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
57 </tool>