annotate README.markdown @ 0:3358c3d30143 draft

Uploaded initial version.
author pjbriggs
date Mon, 01 Dec 2014 10:40:07 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
1 Trimmomatic
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
2 ===========
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
3
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
4 XML tool file and shell script wrapper for the Trimmomatic program, which provides
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
5 various functions for manipluating Illumina FASTQ files.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
6
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
7 Trimmomatic has been developed within Bjorn Usadel's group at RWTH Aachen university:
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
8
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
9 * <http://www.usadellab.org/cms/index.php?page=trimmomatic>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
10
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
11 The reference for Trimmomatic is:
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
12
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
13 * Lohse M, Bolger AM, Nagel A, Fernie AR, Lunn JE, Stitt M, Usadel B. RobiNA: a
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
14 user-friendly, integrated software solution for RNA-Seq-based transcriptomics.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
15 Nucleic Acids Res. 2012 Jul;40(Web Server issue):W622-7)
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
16
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
17 Trimmomatic 0.32 can be obtained from:
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
18
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
19 * <http://www.usadellab.org/cms/uploads/supplementary/Trimmomatic/Trimmomatic-0.32.zip>
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
20
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
21 The tool assumes that two environment variables have been set, in order to find the
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
22 appropriate files:
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
23
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
24 * `TRIMMOMATIC_DIR` should point to the directory holding the
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
25 `trimmomatic-0.32.jar` file, and
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
26
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
27 * `TRIMMOMATIC_ADAPTERS_DIR` should point to the directory holding the adapter
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
28 sequence files (used by the `ILLUMINACLIP` option).
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
29
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
30 Both variables will be set automatically if installing the tool dependencies e.g. via
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
31 a toolshed; otherwise they will need to be set manually in the Galaxy environment.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
32
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
33 To add to Galaxy add the following to tool_conf.xml:
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
34
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
35 <tool file="trimmomatic/trimmomatic.xml" />
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
36
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
37 (The tool no longer uses a `.loc` file to point to the location of the adapter
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
38 sequence files)
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
39
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
40 ### Changes ###
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
41
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
42 0.32.1: Remove `trimmomatic_adapters.loc.sample` and hard-code adapter files into
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
43 the XML wrapper.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
44
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
45 0.32.0: Add tool_dependencies.xml to install Trimmomatic 0.32 automatically and
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
46 (set the environment). Update tool versioning to use Trimmomatic version
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
47 number (i.e. `0.32`) with tool iteration appended (i.e. `.1`).
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
48
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
49 0.0.4: Specify '-threads 6' in <command> section.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
50
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
51 0.0.3 : Added MINLEN, LEADING, TRAILING, CROP and HEADCROP options of trimmomatic.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
52
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
53 0.0.2: Updated ILLUMINACLIP option to use standard adapter sequences (requires the
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
54 trimmomatic_adapters.loc file; sample version is supplied) plus cosmetic
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
55 updates to wording and help text for some options.
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
56
3358c3d30143 Uploaded initial version.
pjbriggs
parents:
diff changeset
57 0.0.1: Initial version