annotate picard_AddCommentsToBam.xml @ 2:801f5e934011 draft default tip

Uploaded
author devteam
date Thu, 23 Oct 2014 11:40:52 -0400
parents b76a4f17bbbb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
1 <tool name="AddCommentsToBam" id="picard_AddCommentsToBam" version="1.122.0">
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
2 <description>add comments to BAM dataset</description>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
3 <requirements><requirement type="package" version="1.122.0">picard</requirement></requirements>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
4
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
5 <macros>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
6 <import>picard_macros.xml</import>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
7 </macros>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
8
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
9 <command>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
10 @java_options@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
11 java -jar \$JAVA_JAR_PATH/AddCommentsToBam.jar
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
12 INPUT="${inputFile}"
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
13 OUTPUT="${outFile}"
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
14 #for $element in $comments:
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
15 COMMENT="${element.comment}"
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
16 #end for
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
17 QUIET=true
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
18 VERBOSITY=ERROR
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
19 VALIDATION_STRINGENCY=${validation_stringency}
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
20 </command>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
21
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
22 <inputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
23 <param format="bam" name="inputFile" type="data" label="Select SAM/BAM dataset or dataset collection" help="If empty, upload or import a SAM/BAM dataset" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
24 <repeat name="comments" title="Comment" min="1" help="You can provide multiple comments">
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
25 <param name="comment" type="text" size="50" label="Add this comment to BAM dataset" help="COMMENT"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
26 </repeat>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
27
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
28 <expand macro="VS" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
29
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
30 </inputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
31
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
32 <outputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
33 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: BAM with comments"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
34 </outputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
35
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
36 <stdio>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
37 <exit_code range="1:" level="fatal"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
38 </stdio>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
39
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
40 <tests>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
41 <test>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
42 <param name="inputFile" value="picard_AddCommentsToBam.bam" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
43 <param name="comment" value="test1" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
44 <param name="validation_stringency" value="LENIENT" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
45 <output name="outFile" file="picard_AddCommentsToBam_test1.bam" ftype="bam" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
46 </test>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
47 </tests>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
48 <help>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
49
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
50 .. class:: infomark
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
51
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
52 **Purpose**
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
53
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
54 Adds one or more comments (@CO) to the header of a specified BAM dataset.
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
55
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
56 @dataset_collections@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
57
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
58 @description@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
59
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
60 COMMENT=String
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
61 C=String Comments to add to the BAM file This option may be specified 0 or more times.
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
62
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
63 @more_info@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
64 </help>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
65 </tool>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
66
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
67
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
68
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
69
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
70
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
71
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
72
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
73
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
74
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
75
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
76
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
77
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
78