annotate tools/rgenetics/rgFastQC.xml @ 1:cdcb0ce84a1b

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:15 -0500
parents 9071e359b9a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool name="Fastqc: Fastqc QC" id="fastqc" version="0.1">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>using FastQC from Babraham</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 rgFastQC.py -i $input_file -d $html_file.files_path -o $html_file -n "$out_prefix" -f $input_file.ext -e ${GALAXY_DATA_INDEX_DIR}/shared/jars/FastQC/fastqc
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 #if $contaminants.dataset and str($contaminants) > ''
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 -c "$contaminants"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 <requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <requirement type="package">FastQC</requirement>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 </requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <param format="fastqsanger,fastq,bam,sam" name="input_file" type="data" label="Short read data from your current history" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 <param name="out_prefix" value="FastQC" type="text" label="Title for the output file - to remind you what the job was for" size="80" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <param name="contaminants" type="data" format="tabular" optional="true" label="Contaminant list"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 help="tab delimited file with 2 columns: name and sequence. For example: Illumina Small RNA RT Primer CAAGCAGAAGACGGCATACGA"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 <data format="html" name="html_file" label="${out_prefix}.html" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <param name="input_file" value="1000gsample.fastq" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <param name="out_prefix" value="fastqc_out" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <param name="contaminants" value="fastqc_contaminants.txt" ftype="tabular" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <output name="html_file" file="fastqc_report.html" ftype="html" lines_diff="100"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 **Purpose**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 FastQC aims to provide a simple way to do some quality control checks on raw
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 sequence data coming from high throughput sequencing pipelines.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 It provides a modular set of analyses which you can use to give a quick
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 impression of whether your data has any problems of
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 which you should be aware before doing any further analysis.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 The main functions of FastQC are:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 - Import of data from BAM, SAM or FastQ files (any variant)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 - Providing a quick overview to tell you in which areas there may be problems
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 - Summary graphs and tables to quickly assess your data
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 - Export of results to an HTML based permanent report
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 - Offline operation to allow automated generation of reports without running the interactive application
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 **FastQC documentation**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 This is a Galaxy interface to the external package FastQC_.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 Specific documentation on FastQC can be found on that site.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 FastQC incorporates the Picard-tools_ libraries for sam/bam processing.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 .. _FastQC: http://www.bioinformatics.bbsrc.ac.uk/projects/fastqc/
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 .. _Picard-tools: http://picard.sourceforge.net/index.shtml
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 The contaminants file parameter was borrowed from the independently developed
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 fastqcwrapper contributed to the Galaxy Community Tool Shed by J. Johnson.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 **Inputs and outputs**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 This wrapper will accept any fastq file as well as sam or bam as the primary file to check.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 It will also take an optional file containing a list of contaminants information, in the form of
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 a tab-delimited file with 2 columns, name and sequence.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 The tool produces a single HTML output file that contains all of the results, including the following:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 - Basic Statistics
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 - Per base sequence quality
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 - Per sequence quality scores
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76 - Per base sequence content
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77 - Per base GC content
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 - Per sequence GC content
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 - Per base N content
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80 - Sequence Length Distribution
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 - Sequence Duplication Levels
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82 - Overrepresented sequences
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83 - Kmer Content
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 All except Basic Statistics and Overrepresented sequences are plots.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 </tool>