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