annotate picard_DownsampleSam.xml @ 0:b76a4f17bbbb draft

Uploaded
author devteam
date Thu, 23 Oct 2014 11:31:30 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
1 <tool name="Downsample SAM/BAM" id="picard_DownsampleSam" version="1.122.0">
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
2 <description>Downsample a file to retain a subset of the reads</description>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
3 <requirements>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
4 <requirement type="package" version="1.122.0">picard</requirement>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
5 </requirements>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
6
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
7 <macros>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
8 <import>picard_macros.xml</import>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
9 </macros>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
10
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
11 <command>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
12 @java_options@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
13 java -jar
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
14 \$JAVA_JAR_PATH/DownsampleSam.jar
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
15 INPUT="${inputFile}"
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
16 OUTPUT="${outFile}"
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
17 PROBABILITY=${probability}
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
18 RANDOM_SEED=${seed}
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
19 QUIET=true
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
20 VERBOSITY=ERROR
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
21 VALIDATION_STRINGENCY=${validation_stringency}
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
22 </command>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
23 <inputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
24 <param format="sam,bam" name="inputFile" type="data" label="Select SAM/BAM dataset or dataset collection" help="If empty, upload or import a SAM or BAM dataset" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
25 <param name="probability" type="float" size="4" min="0.0" max="1.0" label="Probability (between 0 and 1) that any given read will be kept" help="PROBABILITY; specify 1 to keep all reads, 0.1 to keep 10% of the reads" value="1" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
26 <param name="seed" type="integer" size="5" label="Random seed value" help="RANDOM_SEED; default=1" value="1" />
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 <stdio>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
33 <exit_code range="1:" level="fatal"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
34 </stdio>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
35
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
36 <outputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
37 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: downsampled BAM"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
38 </outputs>
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_DownsampleSam.bam" ftype="bam" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
43 <param name="probability" value="0.1" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
44 <param name="seed" value="1024" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
45 <param name="validation_stringency" value="LENIENT" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
46 <output name="outFile" file="picard_DownsampleSam_test1.bam" ftype="bam"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
47 </test>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
48 </tests>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
49 <help>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
50
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
51 .. class:: infomark
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
52
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
53 **Purpose**
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
54
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
55 Randomly down-sample a SAM or BAM file to retain a random subset of the reads. Mate-pairs are either both kept or both discarded. Reads marked as not primary alignments are all discarded. Each read is given a probability P of being retained - results with the exact same input in the same order and with the same value for RANDOM_SEED will produce the same results.
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
56
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
57 @dataset_collections@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
58
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
59 @description@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
60
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
61 INPUT=File
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
62 I=File The input SAM or BAM file to downsample. Required.
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
63
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
64 OUTPUT=File
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
65 O=File The output, downsampled, SAM or BAM file to write. Required.
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
66
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
67 RANDOM_SEED=Long
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
68 R=Long Random seed to use if reproducibilty is desired. Setting to null will cause multiple
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
69 invocations to produce different results.
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
70
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
71 PROBABILITY=Double
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
72 P=Double The probability of keeping any individual read, between 0 and 1.
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 @more_info@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
77 </help>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
78 </tool>