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