annotate picard_CleanSam.xml @ 6:4ff1e04010e6 draft

Uploaded
author devteam
date Thu, 15 Jan 2015 15:37:04 -0500
parents 3d4f1fa26f0e
children 3a3234d7a2e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
1 <tool id="picard_CleanSam" name="CleanSam" version="1.126.0">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
2
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
3 <description>perform SAM/BAM grooming</description>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
4
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
5 <requirements>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
6 <requirement type="package" version="1.126.0">picard</requirement>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
7 </requirements>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
8
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
9 <macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
10 <import>picard_macros.xml</import>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
11 </macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
12
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
13 <command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
14 @java_options@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
15 java -jar \$JAVA_JAR_PATH/picard.jar
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
16 CleanSam
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
17 INPUT="${inputFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
18 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
19 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
20 VERBOSITY=ERROR
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
21 VALIDATION_STRINGENCY=${validation_stringency}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
22 </command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
23
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
24 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
25 <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"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
26
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
27 <expand macro="VS" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
28
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
29 </inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
30
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
31 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
32 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: cleaned BAM dataset">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
33 </data>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
34 </outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
35
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
36 <stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
37 <exit_code range="1:" level="fatal"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 </stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
40 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
41 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42 <param name="inputFile" ftype="bam" value="picard_CleanSam.bam" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43 <output name="outFile" file="picard_CleanSam_test1.bam" ftype="bam" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
44 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
45 </tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
49 .. class:: infomark
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53 Read SAM/BAM and perform various fix-ups. Currently, the only fix-ups are:
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
54
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
55 1. to soft-clip an alignment that hangs off the end of its reference sequence.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
56 2. to set MAPQ to 0 if a read is unmapped.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
57
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
58 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
59
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
60 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
62 </help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63 </tool>