Mercurial > repos > devteam > picard1106

comparison picard_EstimLibComplexity.xml @ 95:6ad4014eddd7 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author devteam
date Mon, 24 Feb 2014 16:51:27 -0500
parents
children
comparison
equal deleted inserted replaced
94:7c6eeaa74990 95:6ad4014eddd7
1 <tool name="Estimate Library Complexity" id="rgEstLibComp" version="1.106.0">
2 <description>estimates library complexity from sequence of read pairs alone</description>
3 <requirements><requirement type="package" version="1.106.0">picard</requirement></requirements>
4 <command interpreter="python">
5 picard_wrapper.py -i "${input_file}" -n "${out_prefix}" --tmpdir "${__new_file_path__}" --minid "${minIDbases}"
6 --maxdiff "${maxDiff}" --minmeanq "${minMeanQ}" --readregex "${readRegex}" --optdupdist "${optDupeDist}"
7 -j "\$JAVA_JAR_PATH/EstimateLibraryComplexity.jar" -d "${html_file.files_path}" -t "${html_file}"
8 </command>
9 <inputs>
10 <param format="bam,sam" name="input_file" type="data" label="SAM/BAM dataset"
11 help="If empty, upload or import a SAM/BAM dataset."/>
12 <param name="out_prefix" value="Library Complexity" type="text"
13 label="Title for the output file" help="Use this remind you what the job was for." size="80" />
14 <param name="minIDbases" value="5" type="integer" label="Minimum identical bases at starts of reads for grouping" size="5"
15 help="Total_reads / 4^max_id_bases reads will be compared at a time. Lower numbers = more accurate results and exponentially more time/memory." />
16 <param name="maxDiff" value="0.03" type="float"
17 label="Maximum difference rate for identical reads" size="5"
18 help="The maximum rate of differences between two reads to call them identical" />
19 <param name="minMeanQ" value="20" type="integer"
20 label="Minimum percentage" size="5"
21 help="The minimum mean quality of bases in a read pair. Lower average quality reads filtered out from all calculations" />
22 <param name="readRegex" value="[a-zA-Z0-9]+:[0-9]:([0-9]+):([0-9]+):([0-9]+).*" type="text" size="120"
23 label="Regular expression that can be used to parse read names in the incoming SAM file"
24 help="Names are parsed to extract: tile/region, x coordinate and y coordinate, to estimate optical duplication rate" >
25 <sanitizer>
26 <valid initial="string.printable">
27 <remove value="&apos;"/>
28 </valid>
29 <mapping initial="none">
30 <add source="&apos;" target="__sq__"/>
31 </mapping>
32 </sanitizer>
33 </param>
34 <param name="optDupeDist" value="100" type="text"
35 label="The maximum offset between two duplicte clusters in order to consider them optical duplicates." size="5"
36 help="e.g. 5-10 pixels. Later Illumina software versions multiply pixel values by 10, in which case 50-100" />
37
38 </inputs>
39 <outputs>
40 <data format="html" name="html_file" label="${out_prefix}_lib_complexity.html"/>
41 </outputs>
42 <tests>
43 <test>
44 <param name="input_file" value="picard_input_tiny.sam" />
45 <param name="out_prefix" value="Library Complexity" />
46 <param name="minIDbases" value="5" />
47 <param name="maxDiff" value="0.03" />
48 <param name="minMeanQ" value="20" />
49 <param name="readRegex" value="[a-zA-Z0-9]+:[0-9]:([0-9]+):([0-9]+):([0-9]+).*" />
50 <param name="optDupeDist" value="100" />
51 <output name="html_file" file="picard_output_estlibcomplexity_tinysam.html" ftype="html" lines_diff="30" />
52 </test>
53 </tests>
54 <help>
55
56 .. class:: infomark
57
58 **Purpose**
59
60 Attempts to estimate library complexity from sequence alone.
61 Does so by sorting all reads by the first N bases (5 by default) of each read and then
62 comparing reads with the first N bases identical to each other for duplicates. Reads are considered to be
63 duplicates if they match each other with no gaps and an overall mismatch rate less than or equal to MAX_DIFF_RATE (0.03 by default).
64
65 Reads of poor quality are filtered out so as to provide a more accurate estimate.
66 The filtering removes reads with any no-calls in the first N bases or with a mean base quality lower than
67 MIN_MEAN_QUALITY across either the first or second read.
68
69 The algorithm attempts to detect optical duplicates separately from PCR duplicates and excludes these in the
70 calculation of library size. Also, since there is no alignment to screen out technical reads one
71 further filter is applied on the data. After examining all reads a histogram is built of
72 [#reads in duplicate set -> #of duplicate sets]; all bins that contain exactly one duplicate set are
73 then removed from the histogram as outliers before library size is estimated.
74
75 **Picard documentation**
76
77 This is a Galaxy wrapper for EstimateLibraryComplexity, a part of the external package Picard-tools_.
78
79 .. _Picard-tools: http://www.google.com/search?q=picard+samtools
80
81 -----
82
83 .. class:: infomark
84
85 **Inputs, outputs, and parameters**
86
87 Picard documentation says (reformatted for Galaxy):
88
89 .. csv-table::
90 :header-rows: 1
91
92 Option Description
93 "INPUT=File","One or more files to combine and estimate library complexity from. Reads can be mapped or unmapped. This option may be specified 0 or more times."
94 "OUTPUT=File","Output file to writes per-library metrics to. Required."
95 "MIN_IDENTICAL_BASES=Integer","The minimum number of bases at the starts of reads that must be identical for reads to be grouped together for duplicate detection. In effect total_reads / 4^max_id_bases reads will be compared at a time, so lower numbers will produce more accurate results but consume exponentially more memory and CPU. Default value: 5."
96 "MAX_DIFF_RATE=Double","The maximum rate of differences between two reads to call them identical. Default value: 0.03. "
97 "MIN_MEAN_QUALITY=Integer","The minimum mean quality of the bases in a read pair for the read to be analyzed. Reads with lower average quality are filtered out and not considered in any calculations. Default value: 20."
98 "READ_NAME_REGEX=String","Regular expression that can be used to parse read names in the incoming SAM file. Read names are parsed to extract three variables: tile/region, x coordinate and y coordinate. These values are used to estimate the rate of optical duplication in order to give a more accurate estimated library size. The regular expression should contain three capture groups for the three variables, in order. Default value: [a-zA-Z0-9]+:[0-9]:([0-9]+):([0-9]+):([0-9]+).*. This option can be set to 'null' to clear the default value."
99 "OPTICAL_DUPLICATE_PIXEL_DISTANCE=Integer","The maximum offset between two duplicte clusters in order to consider them optical duplicates. This should usually be set to some fairly small number (e.g. 5-10 pixels) unless using later versions of the Illumina pipeline that multiply pixel values by 10, in which case 50-100 is more normal. Default value: 100"
100 "CREATE_MD5_FILE=Boolean","Whether to create an MD5 digest for any BAM files created. Default value: false. This option can be set to 'null' to clear the default value. "
101
102 .. class:: warningmark
103
104 **Warning on SAM/BAM quality**
105
106 Many SAM/BAM files produced externally and uploaded to Galaxy do not fully conform to SAM/BAM specifications. Galaxy deals with this by using the **LENIENT**
107 flag when it runs Picard, which allows reads to be discarded if they're empty or don't map. This appears
108 to be the only way to deal with SAM/BAM that cannot be parsed.
109
110 .. class:: infomark
111
112 **Note on the Regular Expression**
113
114 (from the Picard docs)
115 This tool requires a valid regular expression to parse out the read names in the incoming SAM or BAM file.
116 These values are used to estimate the rate of optical duplication in order to give a more accurate estimated library size.
117 The regular expression should contain three capture groups for the three variables, in order.
118 Default value: [a-zA-Z0-9]+:[0-9]:([0-9]+):([0-9]+):([0-9]+).*.
119
120
121 </help>
122 </tool>
123
124