annotate fastqc/README @ 0:1d373f219445 default tip

Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
author jjohnson
date Tue, 07 Jun 2011 17:22:05 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
1
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
2 FastQC
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
3 ------
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
4
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
5 From the FastQC website http://www.bioinformatics.bbsrc.ac.uk/projects/fastqc/
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
6
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
7 Function A quality control tool for high throughput sequence data.
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
8 Language Java
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
9 Requirements A suitable Java Runtime Environment
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
10 The Picard BAM/SAM Libraries (included in download)
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
11 Code Maturity Stable. Mature code, but feedback is appreciated.
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
12 Code Released Yes, under GPL v3 or later.
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
13 Initial Contact Simon Andrews
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
14
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
15 FastQC aims to provide a simple way to do some quality control checks on raw sequence data coming from high throughput sequencing pipelines. It provides a modular set of analyses which you can use to give a quick impression of whether your data has any problems of which you should be aware before doing any further analysis.
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
16
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
17 The main functions of FastQC are:
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
18
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
19 - Import of data from BAM, SAM or FastQ files (any variant)
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
20 - Providing a quick overview to tell you in which areas there may be problems
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
21 - Summary graphs and tables to quickly assess your data
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
22 - Export of results to an HTML based permanent report
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
23 - Offline operation to allow automated generation of reports without running the interactive application
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
24
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
25 Download and installation information is at: http://www.bioinformatics.bbsrc.ac.uk/projects/download.html#fastqc
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
26
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
27
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
28 Galaxy Tool Wrapper
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
29 -------------------
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
30
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
31 The galaxy tool wrapper for FastQC requires version: FastQC v0.7.2
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
32
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
33 FastQC should be downloaded and installed on the system on which it will be executed.
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
34 The PATH environment variable should include the directory in which the fastqc script resides.
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
35
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
36 The fastqc.py wrapper invokes the fastqc script provided in FastQC download,
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
37 and converts the FastQC results into a Galaxy html formatted dataset.
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
38
1d373f219445 Migrated tool version 1.0.0 from old tool shed archive to new tool shed repository
jjohnson
parents:
diff changeset
39