annotate picard_DownsampleSam.xml @ 5:3d4f1fa26f0e draft

Uploaded
author devteam
date Tue, 16 Dec 2014 19:03:21 -0500
parents
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="Downsample SAM/BAM" id="picard_DownsampleSam" version="1.126.0">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
2 <description>Downsample a file to retain a subset of the reads</description>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
3 <requirements>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
4 <requirement type="package" version="1.126.0">picard</requirement>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
5 </requirements>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
6
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
7 <macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
8 <import>picard_macros.xml</import>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
9 </macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
10
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
11 <command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
12 @java_options@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
13 java -jar
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
14 \$JAVA_JAR_PATH/picard.jar
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
15 DownsampleSam
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
16 INPUT="${inputFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
17 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
18 PROBABILITY=${probability}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
19 RANDOM_SEED=${seed}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
20 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
21 VERBOSITY=ERROR
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
22 VALIDATION_STRINGENCY=${validation_stringency}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
23 </command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
24 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
25 <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" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
26 <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" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
27 <param name="seed" type="integer" size="5" label="Random seed value" help="RANDOM_SEED; default=1" value="1" />
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 <stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
34 <exit_code range="1:" level="fatal"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
35 </stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
36
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
37 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: downsampled BAM"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39 </outputs>
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_DownsampleSam.bam" ftype="bam" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
44 <param name="probability" value="0.1" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
45 <param name="seed" value="1024" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46 <param name="validation_stringency" value="LENIENT" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47 <output name="outFile" file="picard_DownsampleSam_test1.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
49 </tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52 .. class:: infomark
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
54 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
55
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
56 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.
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 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
62 INPUT=File
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63 I=File The input SAM or BAM file to downsample. Required.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
64
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
65 OUTPUT=File
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
66 O=File The output, downsampled, SAM or BAM file to write. Required.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
67
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
68 RANDOM_SEED=Long
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
69 R=Long Random seed to use if reproducibilty is desired. Setting to null will cause multiple
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
70 invocations to produce different results.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
71
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
72 PROBABILITY=Double
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
73 P=Double The probability of keeping any individual read, between 0 and 1.
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 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
78 </help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
79 </tool>