Mercurial > repos > fubar > fastqc_320

annotate FastQC/rgFastQC.xml @ 13:c3ac02711af2 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author fubar
date Mon, 03 Jun 2013 23:59:16 -0400
parents c13fa2748191
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
1 <tool name="FastQC: Comprehensive QC" id="fastqc" version="0.53">
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
2 <description>reporting for short read sequence</description>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
3 <command interpreter="python">
9
c13fa2748191 Uploaded
fubar
parents: 0
diff changeset
4 rgFastQC.py -i "$input_file" -d "$html_file.files_path" -o "$html_file" -n "$out_prefix" -f "$input_file.ext" -j "$input_file.name" -e "\$FASTQC_BINARY_PATH"
0
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
5 #if $contaminants.dataset and str($contaminants) > ''
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
6 -c "$contaminants"
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
7 #end if
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
8 </command>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
9 <requirements>
9
c13fa2748191 Uploaded
fubar
parents: 0
diff changeset
10 <requirement type="set_environment">FASTQC_BINARY_PATH</requirement>
0
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
11 <requirement type="package" version="0.10.1">FastQC</requirement>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
12 </requirements>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
13 <inputs>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
14 <param format="fastqsanger,fastq,bam,sam" name="input_file" type="data" label="Short read data from your current history" />
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
15 <param name="out_prefix" value="FastQC" type="text" label="Title for the output file - to remind you what the job was for" size="80"
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
16 help="Letters and numbers only please - other characters will be removed">
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
17 <sanitizer invalid_char="">
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
18 <valid initial="string.letters,string.digits"/>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
19 </sanitizer>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
20 </param>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
21 <param name="contaminants" type="data" format="tabular" optional="true" label="Contaminant list"
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
22 help="tab delimited file with 2 columns: name and sequence. For example: Illumina Small RNA RT Primer CAAGCAGAAGACGGCATACGA"/>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
23 </inputs>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
24 <outputs>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
25 <data format="html" name="html_file" label="${out_prefix}_${input_file.name}.html" />
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
26 </outputs>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
27 <tests>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
28 <test>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
29 <param name="input_file" value="1000gsample.fastq" />
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
30 <param name="out_prefix" value="fastqc_out" />
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
31 <param name="contaminants" value="fastqc_contaminants.txt" ftype="tabular" />
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
32 <output name="html_file" file="fastqc_report.html" ftype="html" lines_diff="100"/>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
33 </test>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
34 </tests>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
35 <help>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
36
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
37 .. class:: infomark
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
38
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
39 **Purpose**
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
40
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
41 FastQC aims to provide a simple way to do some quality control checks on raw
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
42 sequence data coming from high throughput sequencing pipelines.
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
43 It provides a modular set of analyses which you can use to give a quick
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
44 impression of whether your data has any problems of
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
45 which you should be aware before doing any further analysis.
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
46
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
47 The main functions of FastQC are:
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
48
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
49 - Import of data from BAM, SAM or FastQ files (any variant)
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
50 - Providing a quick overview to tell you in which areas there may be problems
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
51 - Summary graphs and tables to quickly assess your data
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
52 - Export of results to an HTML based permanent report
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
53 - Offline operation to allow automated generation of reports without running the interactive application
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
54
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
55
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
56 -----
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
57
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
58
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
59 .. class:: infomark
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
60
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
61 **FastQC**
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
62
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
63 This is a Galaxy wrapper. It merely exposes the external package FastQC_ which is documented at FastQC_
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
64 Kindly acknowledge it as well as this tool if you use it.
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
65 FastQC incorporates the Picard-tools_ libraries for sam/bam processing.
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
66
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
67 The contaminants file parameter was borrowed from the independently developed
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
68 fastqcwrapper contributed to the Galaxy Community Tool Shed by J. Johnson.
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
69
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
70 -----
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
71
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
72 .. class:: infomark
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
73
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
74 **Inputs and outputs**
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
75
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
76 FastQC_ is the best place to look for documentation - it's very good.
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
77 A summary follows below for those in a tearing hurry.
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
78
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
79 This wrapper will accept a Galaxy fastq, sam or bam as the input read file to check.
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
80 It will also take an optional file containing a list of contaminants information, in the form of
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
81 a tab-delimited file with 2 columns, name and sequence.
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
82
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
83 The tool produces a single HTML output file that contains all of the results, including the following:
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
84
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
85 - Basic Statistics
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
86 - Per base sequence quality
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
87 - Per sequence quality scores
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
88 - Per base sequence content
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
89 - Per base GC content
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
90 - Per sequence GC content
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
91 - Per base N content
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
92 - Sequence Length Distribution
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
93 - Sequence Duplication Levels
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
94 - Overrepresented sequences
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
95 - Kmer Content
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
96
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
97 All except Basic Statistics and Overrepresented sequences are plots.
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
98 .. _FastQC: http://www.bioinformatics.bbsrc.ac.uk/projects/fastqc/
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
99 .. _Picard-tools: http://picard.sourceforge.net/index.shtml
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
100
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
101 </help>
42251cbdeeac Initial commit of test for FastQC with installation of the java stuff
fubar
parents:
diff changeset
102 </tool>