annotate README.rst @ 8:4e625d3672ba draft

Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
author pjbriggs
date Wed, 16 May 2018 07:39:16 -0400
parents 5e133b7b79a6
children 52dbe2089d14
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
1 pal_finder: find microsatellite repeats and design PCR primers
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
2 ==============================================================
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
3
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
4 Galaxy tool wrapper for the pal_finder microsatellite and PCR primer design script.
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
5
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
6 Automated installation
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
7 ======================
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
8
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
9 Installation via the Galaxy Tool Shed will take of installing the tool wrapper and
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
10 the pal_finder and primer3_core programs (plus additional dependencies), and setting
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
11 the appropriate environment variables.
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
12
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
13 Manual Installation
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
14 ===================
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
15
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
16 There are three files to install:
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
17
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
18 - ``pal_finder_wrapper.xml`` (the Galaxy tool definition)
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
19 - ``pal_finder_wrapper.sh`` (the shell script wrapper)
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
20 - ``pal_finder_filter_and_assembly.py`` (filtering utility)
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
21
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
22 The suggested location is in a ``tools/pal_finder_wrapper/`` folder. You will then
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
23 need to modify the ``tools_conf.xml`` file to tell Galaxy to offer the tool
3
e1a14ed7a9d6 Updated to version 0.02.04.4 (new pal_filter script)
pjbriggs
parents: 2
diff changeset
24 by adding the line::
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
25
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
26 <tool file="pal_finder/pal_finder_wrapper.xml" />
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
27
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
28 You will also need to install the pal_finder and primer3 packages:
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
29
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
30 - ``pal_finder`` can be obtained from http://sourceforge.net/projects/palfinder/
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
31 - ``Primer3`` version 2.0.0-alpha (see the pal_finder installation notes) can be
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
32 obtained from http://primer3.sourceforge.net/releases.php
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
33
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
34 Additionally the filtering script needs ``BioPython`` and the ``PANDASeq`` program:
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
35
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
36 - ``BioPython`` can be obtained from https://pypi.python.org/packages/source/b/biopython/
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
37 - ``PANDASeq`` version 2.8.1 can be obtained from https://github.com/neufeld/pandaseq/
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
38
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
39 The tool wrapper must be able to locate the ``pal_finder_v0.02.04.pl`` script, the
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
40 example pal_finder ``config.txt`` and ``simple.ref`` data files, and the
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
41 ``primer3_core`` program - the locations of these are taken from the following
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
42 enviroment variables which you will need to set manually:
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
43
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
44 - ``PALFINDER_SCRIPT_DIR``: location of the pal_finder Perl script (defaults to /usr/bin)
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
45 - ``PALFINDER_DATA_DIR``: location of the pal_finder data files (specifically config.txt
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
46 and simple.ref; defaults to /usr/share/pal_finder_v0.02.04)
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
47 - ``PRIMER3_CORE_EXE``: name of the primer3_core program, which should include the
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
48 full path if it's not on the Galaxy user's PATH (defaults to primer3_core)
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
49
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
50 If you want to run the functional tests, copy the sample test files under
3
e1a14ed7a9d6 Updated to version 0.02.04.4 (new pal_filter script)
pjbriggs
parents: 2
diff changeset
51 sample test files under Galaxy's ``test-data/`` directory. Then::
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
52
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
53 ./run_tests.sh -id microsat_pal_finder
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
54
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
55 You will need to have set the environment variables above.
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
56
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
57 History
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
58 =======
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
59
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
60 ========== ======================================================================
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
61 Version Changes
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
62 ---------- ----------------------------------------------------------------------
6
a73c48890bde Version v0.02.04.5: handle large output files
pjbriggs
parents: 3
diff changeset
63
8
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
64 0.02.04.7 - Trap for errors in ``pal_finder_v0.02.04.pl`` resulting in bad
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
65 ranges being supplied to ``primer3_core`` for some reads via
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
66 ``PRIMER_PRODUCT_RANGE_SIZE`` (and enable 'bad' reads to be output
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
67 to a dataset); add new option to use a random subset of reads for
4e625d3672ba Pal_finder tool version 0.02.04.7: add detection/reporting of bad ranges; enable subset of reads to be used; check n-mers.
pjbriggs
parents: 7
diff changeset
68 microsatellite detection.
7
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
69 0.02.04.6 - Update to get dependencies using ``conda`` when installed from the
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
70 toolshed (this removes the explicit dependency on Perl 5.16
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
71 introduced in 0.02.04.2, as a result the outputs from the tool are
5e133b7b79a6 Uploaded version 0.02.04.6 (uses conda dependency resolution).
pjbriggs
parents: 6
diff changeset
72 now non-deterministic in some cases).
6
a73c48890bde Version v0.02.04.5: handle large output files
pjbriggs
parents: 3
diff changeset
73 0.02.04.5 - Update to handle large output files which can sometimes be generated
a73c48890bde Version v0.02.04.5: handle large output files
pjbriggs
parents: 3
diff changeset
74 by the ``pal_finder_v0.02.04.pl`` or ``pal_filter.py`` scripts (logs
a73c48890bde Version v0.02.04.5: handle large output files
pjbriggs
parents: 3
diff changeset
75 of hundreds of Gb's have been observed in production): log files
a73c48890bde Version v0.02.04.5: handle large output files
pjbriggs
parents: 3
diff changeset
76 longer than 500 lines are now truncated to avoid downstream problems.
3
e1a14ed7a9d6 Updated to version 0.02.04.4 (new pal_filter script)
pjbriggs
parents: 2
diff changeset
77 0.02.04.4 - Update to the filter script (``pal_filter.py``) which removes some
e1a14ed7a9d6 Updated to version 0.02.04.4 (new pal_filter script)
pjbriggs
parents: 2
diff changeset
78 columns from the output assembly file.
2
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
79 0.02.04.3 - Update to the Illumina filtering script from Graeme Fox (including
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
80 new option to run ``PANDASeq`` assembly/QC steps), and corresponding
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
81 update to the tool; add support for input FASTQs to be a dataset
b6ccc7dd7b02 Version 0.02.04.3.
pjbriggs
parents: 1
diff changeset
82 collection pair.
1
771ebe02636f Uploaded version 0.02.04.2: fix bug that causes tool to fail when prefix includes spaces; add explicit dependency on Perl 5.16.3.
pjbriggs
parents: 0
diff changeset
83 0.02.04.2 - Fix bug that causes tool to fail when prefix includes spaces;
771ebe02636f Uploaded version 0.02.04.2: fix bug that causes tool to fail when prefix includes spaces; add explicit dependency on Perl 5.16.3.
pjbriggs
parents: 0
diff changeset
84 add explicit dependency on Perl 5.16.3.
0
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
85 0.02.04.1 - Add option to run Graeme Fox's ``pal_finder_filter.pl`` script to
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
86 filter and sort the pal_finder output (Illumina input data only).
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
87 Update version number to reflect the pal_finder version.
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
88 0.0.6 - Allow input data to be either Illumina paired-end data in fastq
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
89 format or single-end 454 data in fasta format.
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
90 0.0.5 - Allow custom mispriming library to be specified; added
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
91 ``tool_dependencies.xml`` file to install pal_finder and primer3
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
92 programs and configure environment for Galaxy automatically.
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
93 0.0.4 - Added more custom options for primer3_core for selecting primers on
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
94 size, GC and melting temperature criteria.
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
95 0.0.3 - Check that pal_finder script & config file, and primer3_core
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
96 executable are all available; move PRIMER_MIN_TM parameter to new
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
97 "custom" section for primer3 settings
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
98 0.0.2 - Updated pal_finder_wrapper.sh to allow locations of pal_finder Perl
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
99 script, data files and primer_core3 program to be set via environment
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
100 variables
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
101 0.0.1 - Initial version
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
102 ========== ======================================================================
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
103
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
104
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
105 Developers
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
106 ==========
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
107
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
108 This tool is developed on the following GitHub repository:
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
109 https://github.com/fls-bioinformatics-core/galaxy-tools/tree/master/pal_finder
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
110
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
111 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball I use
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
112 the ``package_pal_finder.sh`` script.
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
113
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
114
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
115 Licence (MIT)
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
116 =============
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
117
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
118 Permission is hereby granted, free of charge, to any person obtaining a copy
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
119 of this software and associated documentation files (the "Software"), to deal
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
120 in the Software without restriction, including without limitation the rights
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
121 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
122 copies of the Software, and to permit persons to whom the Software is
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
123 furnished to do so, subject to the following conditions:
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
124
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
125 The above copyright notice and this permission notice shall be included in
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
126 all copies or substantial portions of the Software.
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
127
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
128 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
129 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
130 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
131 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
132 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
133 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
3f908e7fff4f Uploaded first version to toolshed.
pjbriggs
parents:
diff changeset
134 THE SOFTWARE.