annotate README.rst @ 3:f8a9a5eaca8a draft

Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
author pjbriggs
date Wed, 23 Sep 2015 08:59:23 -0400
parents a60283899c6d
children 14d05f2d511d
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
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
22 Manual Installation
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
23 ===================
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
24
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
25 There are two files to install:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
26
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
27 - ``trimmomatic.xml`` (the Galaxy tool definition)
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
28 - ``trimmomatic.sh`` (the shell script wrapper)
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
29
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
30 The suggested location is in a ``tools/trimmomatic/`` folder. You will then
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
31 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
32 by adding the line:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
33
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
34 <tool file="trimmomatic/trimmomatic.xml" />
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
35
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
36 You will also need to install trimmomatic 0.32:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
37
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
38 - http://www.usadellab.org/cms/uploads/supplementary/Trimmomatic/Trimmomatic-0.32.zip
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
39
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
40 The tool wrapper uses the following environment variables in order to find the
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
41 appropriate files:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
42
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
43 - ``TRIMMOMATIC_DIR`` should point to the directory holding the
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
44 ``trimmomatic-0.32.jar`` file
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
45 - ``TRIMMOMATIC_ADAPTERS_DIR`` should point to the directory holding the adapter
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
46 sequence files (used by the ``ILLUMINACLIP`` option).
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
47
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
48 If you want to run the functional tests, copy the sample test files under
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
49 sample test files under Galaxy's ``test-data/`` directory. Then:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
50
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
51 ./run_tests.sh -id trimmomatic
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
52
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
53 You will need to have set the environment variables above.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
54
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
55 History
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
56 =======
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
57
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
58 ========== ======================================================================
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
59 Version Changes
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
60 ---------- ----------------------------------------------------------------------
3
f8a9a5eaca8a Updated to version 0.32.3: add support for FASTQ pairs (dataset collections)
pjbriggs
parents: 2
diff changeset
61 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
62 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
63 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
64 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
65 at runtime (default is 6).
1
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
66 0.32.1 - Remove ``trimmomatic_adapters.loc.sample`` and hard-code adapter files
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
67 into the XML wrapper.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
68 0.32.0 - Add tool_dependencies.xml to install Trimmomatic 0.32 automatically and
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
69 set the environment.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
70 - Update tool versioning to use Trimmomatic version number (i.e. ``0.32``)
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
71 with tool iteration appended (i.e. ``.1``).
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
72 0.0.4 - Specify '-threads 6' in <command> section.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
73 0.0.3 - Added MINLEN, LEADING, TRAILING, CROP and HEADCROP options of trimmomatic.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
74 0.0.2 - Updated ILLUMINACLIP option to use standard adapter sequences (requires
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
75 the trimmomatic_adapters.loc file; sample version is supplied) plus
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
76 cosmetic updates to wording and help text for some options.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
77 0.0.1 - Initial version
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
78 ========== ======================================================================
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
79
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
80
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
81 Developers
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
82 ==========
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
83
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
84 This tool is developed on the following GitHub repository:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
85 https://github.com/fls-bioinformatics-core/galaxy-tools/tree/master/trimmomatic
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
86
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
87 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
88 the ``package_trimmomatic.sh`` script.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
89
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
90
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
91 Licence (MIT)
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
92 =============
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
93
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
94 Permission is hereby granted, free of charge, to any person obtaining a copy
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
95 of this software and associated documentation files (the "Software"), to deal
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
96 in the Software without restriction, including without limitation the rights
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
97 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
98 copies of the Software, and to permit persons to whom the Software is
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
99 furnished to do so, subject to the following conditions:
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
100
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
101 The above copyright notice and this permission notice shall be included in
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
102 all copies or substantial portions of the Software.
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
103
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
104 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
105 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
106 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
107 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
108 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2bd7cdbb6228 Add README and citation tags.
pjbriggs
parents:
diff changeset
109 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
110 THE SOFTWARE.