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