annotate tools/filters/get_orfs_or_cdss.txt @ 0:9cff9a1176ea

Uploaded v0.0.1
author peterjc
date Thu, 19 Jan 2012 10:17:10 -0500
parents
children 922d69bd5258
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
1 Galaxy tool to find ORFs or simple CDSs
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
2 =======================================
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
3
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
4 This tool is copyright 2011 by Peter Cock, The James Hutton Institute
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved.
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
6 See the licence text below.
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
7
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
8 This tool is a short Python script (using Biopython library functions)
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
9 to search nucleotide sequences for open reading frames (ORFs) or coding
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
10 sequences (CDSs) where the first potential start codon is used. See the
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
11 help text in the XML file for more information.
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
12
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
13 There are just two files to install:
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
14
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
15 * get_orfs_or_cdss.py (the Python script)
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
16 * get_orfs_or_cdss.xml (the Galaxy tool definition)
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
17
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
18 The suggested location is in the Galaxy folder tools/filters next to the tool
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
19 for calling sff_extract.py for converting SFF to FASTQ or FASTA + QUAL.
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
20
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
21 You will also need to modify the tools_conf.xml file to tell Galaxy to offer the
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
22 tool. One suggested location is in the filters section. Simply add the line:
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
23
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
24 <tool file="filters/get_orfs_or_cdss.xml" />
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
25
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
26 You will also need to install Biopython 1.54 or later. If you want to run
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
27 the unit tests, include this line in tools_conf.xml.sample and the sample
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
28 FASTA files under the test-data directory. That's it.
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
29
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
30
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
31 History
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
32 =======
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
33
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
34 v0.0.1 - Initial version.
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
35
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
36
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
37 Developers
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
38 ==========
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
39
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
40 This script and related tools are being developed on the following hg branch:
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
41 http://bitbucket.org/peterjc/galaxy-central/src/tools
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
42
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
43 For making the "Galaxy Tool Shed" http://community.g2.bx.psu.edu/ tarball use
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
44 the following command from the Galaxy root folder:
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
45
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
46 tar -czf get_orfs_or_cdss.tar.gz tools/filters/get_orfs_or_cdss.*
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
47
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
48 Check this worked:
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
49
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
50 $ tar -tzf get_orfs_or_cdss.tar.gz
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
51 filter/get_orfs_or_cdss.py
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
52 filter/get_orfs_or_cdss.txt
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
53 filter/get_orfs_or_cdss.xml
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
54
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
55
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
56 Licence (MIT/BSD style)
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
57 =======================
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
58
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
59 Permission to use, copy, modify, and distribute this software and its
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
60 documentation with or without modifications and for any purpose and
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
61 without fee is hereby granted, provided that any copyright notices
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
62 appear in all copies and that both those copyright notices and this
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
63 permission notice appear in supporting documentation, and that the
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
64 names of the contributors or copyright holders not be used in
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
65 advertising or publicity pertaining to distribution of the software
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
66 without specific prior permission.
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
67
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
68 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
69 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
70 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
71 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
72 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
73 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
74 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
9cff9a1176ea Uploaded v0.0.1
peterjc
parents:
diff changeset
75 OR PERFORMANCE OF THIS SOFTWARE.