annotate README.rst @ 7:6eeacf19a38e draft

Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
author pjbriggs
date Tue, 21 Mar 2017 08:42:05 -0400
parents 141bba0e9a77
children 415a165d92bb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
1 Trimmomatic: flexible read trimming tool for Illumina NGS data
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
2 ==============================================================
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
3
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
4 Galaxy tool wrapper for the Trimmomatic program, which provides various functions for
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
5 manipluating Illumina FASTQ files (both single and paired-end).
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
6
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
7 Trimmomatic has been developed within Bjorn Usadel's group at RWTH Aachen university
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
8 http://www.usadellab.org/cms/index.php?page=trimmomatic
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
9
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
10 The reference for Trimmomatic is:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
11
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
12 - Bolger, A.M., Lohse, M., & Usadel, B. (2014). Trimmomatic: A flexible trimmer
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
13 for Illumina Sequence Data. Bioinformatics, btu170.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
14
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
15 Automated installation
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
16 ======================
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
17
2
a60283899c6d Version 0.32.2: use GALAXY_SLOTS to set number of threads.
pjbriggs
parents: 1
diff changeset
18 Installation via the Galaxy Tool Shed will take care of installing the tool wrapper
a60283899c6d Version 0.32.2: use GALAXY_SLOTS to set number of threads.
pjbriggs
parents: 1
diff changeset
19 and the trimmomatic program and data, and setting the appropriate environment
a60283899c6d Version 0.32.2: use GALAXY_SLOTS to set number of threads.
pjbriggs
parents: 1
diff changeset
20 variables.
1
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
21
7
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
22 Controlling the available memory
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
23 ================================
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
24
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
25 The default amount of memory avilable to trimmomatic is set to 8GB.
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
26 To change the default amount of memory you can set the environment variable
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
27 ``_JAVA_OPTIONS`` to ``-Xmx<amount_of_memory_in_GB>G``. The recommended way to
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
28 set this is in the job_conf.xml file. To change the available memory to 6GB, a
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
29 line like the below should be added:
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
30
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
31 ``<env id="_JAVA_OPTIONS">-Xmx6G</env>``
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
32
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
33 This will set the environment variable ``_JAVA_OPTIONS`` to ``-Xmx6G``.
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
34
1
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
35 Manual Installation
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
36 ===================
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
37
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
38 There are two files to install:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
39
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
40 - ``trimmomatic.xml`` (the Galaxy tool definition)
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
41 - ``trimmomatic.sh`` (the shell script wrapper)
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
42
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
43 The suggested location is in a ``tools/trimmomatic/`` folder. You will then
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
44 need to modify the ``tools_conf.xml`` file to tell Galaxy to offer the tool
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
45 by adding the line:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
46
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
47 <tool file="trimmomatic/trimmomatic.xml" />
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
48
4
14d05f2d511d Version that supports Trimmomatic 0.36.
pjbriggs
parents: 3
diff changeset
49 You will also need to install trimmomatic 0.36:
1
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
50
4
14d05f2d511d Version that supports Trimmomatic 0.36.
pjbriggs
parents: 3
diff changeset
51 - http://www.usadellab.org/cms/uploads/supplementary/Trimmomatic/Trimmomatic-0.36.zip
1
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
52
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
53 The tool wrapper uses the following environment variables in order to find the
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
54 appropriate files:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
55
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
56 - ``TRIMMOMATIC_DIR`` should point to the directory holding the
4
14d05f2d511d Version that supports Trimmomatic 0.36.
pjbriggs
parents: 3
diff changeset
57 ``trimmomatic-0.36.jar`` file
1
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
58 - ``TRIMMOMATIC_ADAPTERS_DIR`` should point to the directory holding the adapter
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
59 sequence files (used by the ``ILLUMINACLIP`` option).
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
60
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
61 If you want to run the functional tests, copy the sample test files under
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
62 sample test files under Galaxy's ``test-data/`` directory. Then:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
63
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
64 ./run_tests.sh -id trimmomatic
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
65
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
66 You will need to have set the environment variables above.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
67
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
68 History
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
69 =======
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
70
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
71 ========== ======================================================================
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
72 Version Changes
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
73 ---------- ----------------------------------------------------------------------
7
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
74 0.36.3 - Fix naming of output collections. Instead of all outputs being called
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
75 "Trimmomatic on collection NN" these will now be called "Trimmomatic
6eeacf19a38e Version 0.36.3: fix the naming of output collections to differentiate btwn paired/unpaired; document the _JAVA_OPTIONS env var (thanks Marius van den Beek).
pjbriggs
parents: 6
diff changeset
76 on collection NN: paired" or "Trimmomatic on collection NN: unpaired".
6
141bba0e9a77 Uploaded v0.36.2 (adds support for compressed fastq inputs)
pjbriggs
parents: 5
diff changeset
77 0.36.2 - Support fastqsanger.gz datatype. If fastqsanger.gz is used as input
141bba0e9a77 Uploaded v0.36.2 (adds support for compressed fastq inputs)
pjbriggs
parents: 5
diff changeset
78 the output will also be fastqsanger.gz.
141bba0e9a77 Uploaded v0.36.2 (adds support for compressed fastq inputs)
pjbriggs
parents: 5
diff changeset
79 - Use $_JAVA_OPTIONS to customize memory requirements.
5
f80107cdc406 Updated to 0.36.1: Reimplement to work with bioconda Trimmomatic 0.36 (toolshed version is still supported for now).
pjbriggs
parents: 4
diff changeset
80 0.36.1 - Reimplement to work with bioconda Trimmomatic 0.36 (toolshed version
f80107cdc406 Updated to 0.36.1: Reimplement to work with bioconda Trimmomatic 0.36 (toolshed version is still supported for now).
pjbriggs
parents: 4
diff changeset
81 is still supported for now).
4
14d05f2d511d Version that supports Trimmomatic 0.36.
pjbriggs
parents: 3
diff changeset
82 0.36.0 - Update to Trimmomatic 0.36.
14d05f2d511d Version that supports Trimmomatic 0.36.
pjbriggs
parents: 3
diff changeset
83 0.32.4 - Add support for ``AVGQUAL`` and ``MAXINFO`` operations.
3
f8a9a5eaca8a Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents: 2
diff changeset
84 0.32.3 - Add support for FASTQ R1/R2 pairs using dataset collections (input
f8a9a5eaca8a Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents: 2
diff changeset
85 can be dataset collection, in which case tool also outputs dataset
f8a9a5eaca8a Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents: 2
diff changeset
86 collections) and improve order and naming of output files.
2
a60283899c6d Version 0.32.2: use GALAXY_SLOTS to set number of threads.
pjbriggs
parents: 1
diff changeset
87 0.32.2 - Use ``GALAXY_SLOTS`` to set the appropriate number of threads to use
a60283899c6d Version 0.32.2: use GALAXY_SLOTS to set number of threads.
pjbriggs
parents: 1
diff changeset
88 at runtime (default is 6).
1
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
89 0.32.1 - Remove ``trimmomatic_adapters.loc.sample`` and hard-code adapter files
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
90 into the XML wrapper.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
91 0.32.0 - Add tool_dependencies.xml to install Trimmomatic 0.32 automatically and
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
92 set the environment.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
93 - Update tool versioning to use Trimmomatic version number (i.e. ``0.32``)
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
94 with tool iteration appended (i.e. ``.1``).
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
95 0.0.4 - Specify '-threads 6' in <command> section.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
96 0.0.3 - Added MINLEN, LEADING, TRAILING, CROP and HEADCROP options of trimmomatic.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
97 0.0.2 - Updated ILLUMINACLIP option to use standard adapter sequences (requires
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
98 the trimmomatic_adapters.loc file; sample version is supplied) plus
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
99 cosmetic updates to wording and help text for some options.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
100 0.0.1 - Initial version
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
101 ========== ======================================================================
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
102
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
103
6
141bba0e9a77 Uploaded v0.36.2 (adds support for compressed fastq inputs)
pjbriggs
parents: 5
diff changeset
104 Credits
141bba0e9a77 Uploaded v0.36.2 (adds support for compressed fastq inputs)
pjbriggs
parents: 5
diff changeset
105 =======
141bba0e9a77 Uploaded v0.36.2 (adds support for compressed fastq inputs)
pjbriggs
parents: 5
diff changeset
106
141bba0e9a77 Uploaded v0.36.2 (adds support for compressed fastq inputs)
pjbriggs
parents: 5
diff changeset
107 This wrapper has been developed and is maintained by Peter Briggs (@pjbriggs).
141bba0e9a77 Uploaded v0.36.2 (adds support for compressed fastq inputs)
pjbriggs
parents: 5
diff changeset
108 Peter van Heusden (@pvanheus) and Marius van den Beek (@mvdbeek) contributed
141bba0e9a77 Uploaded v0.36.2 (adds support for compressed fastq inputs)
pjbriggs
parents: 5
diff changeset
109 support for gz compressed FastQ files.
141bba0e9a77 Uploaded v0.36.2 (adds support for compressed fastq inputs)
pjbriggs
parents: 5
diff changeset
110
141bba0e9a77 Uploaded v0.36.2 (adds support for compressed fastq inputs)
pjbriggs
parents: 5
diff changeset
111
1
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
112 Developers
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
113 ==========
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
114
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
115 This tool is developed on the following GitHub repository:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
116 https://github.com/fls-bioinformatics-core/galaxy-tools/tree/master/trimmomatic
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
117
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
118 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball I use
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
119 the ``package_trimmomatic.sh`` script.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
120
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
121
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
122 Licence (MIT)
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
123 =============
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
124
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
125 Permission is hereby granted, free of charge, to any person obtaining a copy
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
126 of this software and associated documentation files (the "Software"), to deal
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
127 in the Software without restriction, including without limitation the rights
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
128 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
129 copies of the Software, and to permit persons to whom the Software is
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
130 furnished to do so, subject to the following conditions:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
131
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
132 The above copyright notice and this permission notice shall be included in
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
133 all copies or substantial portions of the Software.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
134
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
135 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
136 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
137 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
138 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
139 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
140 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
141 THE SOFTWARE.