comparison tools/filters/get_orfs_or_cdss.txt @ 1:922d69bd5258 draft

Uploaded v0.0.2, fixes labelling issue on reverse strand.
author peterjc
date Tue, 29 Jan 2013 10:19:01 -0500
parents 9cff9a1176ea
children 324775a016ce
comparison
equal deleted inserted replaced
0:9cff9a1176ea 1:922d69bd5258
1 Galaxy tool to find ORFs or simple CDSs 1 Galaxy tool to find ORFs or simple CDSs
2 ======================================= 2 =======================================
3 3
4 This tool is copyright 2011 by Peter Cock, The James Hutton Institute 4 This tool is copyright 2011-2013 by Peter Cock, The James Hutton Institute
5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved. 5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved.
6 See the licence text below. 6 See the licence text below.
7 7
8 This tool is a short Python script (using Biopython library functions) 8 This tool is a short Python script (using Biopython library functions)
9 to search nucleotide sequences for open reading frames (ORFs) or coding 9 to search nucleotide sequences for open reading frames (ORFs) or coding
13 There are just two files to install: 13 There are just two files to install:
14 14
15 * get_orfs_or_cdss.py (the Python script) 15 * get_orfs_or_cdss.py (the Python script)
16 * get_orfs_or_cdss.xml (the Galaxy tool definition) 16 * get_orfs_or_cdss.xml (the Galaxy tool definition)
17 17
18 The suggested location is in the Galaxy folder tools/filters next to the tool 18 If you are installing this manually (rather than via the Tool Shed), the
19 suggested location is in the Galaxy folder tools/filters next to the tool
19 for calling sff_extract.py for converting SFF to FASTQ or FASTA + QUAL. 20 for calling sff_extract.py for converting SFF to FASTQ or FASTA + QUAL.
20
21 You will also need to modify the tools_conf.xml file to tell Galaxy to offer the 21 You will also need to modify the tools_conf.xml file to tell Galaxy to offer the
22 tool. One suggested location is in the filters section. Simply add the line: 22 tool. One suggested location is in the filters section. Simply add the line:
23 23
24 <tool file="filters/get_orfs_or_cdss.xml" /> 24 <tool file="filters/get_orfs_or_cdss.xml" />
25 25
26 You will also need to install Biopython 1.54 or later. If you want to run 26 You will also need to install Biopython 1.54 or later. If you want to run
27 the unit tests, include this line in tools_conf.xml.sample and the sample 27 the unit tests, include this line in tools_conf.xml.sample and the sample
28 FASTA files under the test-data directory. That's it. 28 FASTA files under the test-data directory. Then:
29
30 ./run_functional_tests.sh -id get_orfs_or_cdss
31
32 That's it.
29 33
30 34
31 History 35 History
32 ======= 36 =======
33 37
34 v0.0.1 - Initial version. 38 v0.0.1 - Initial version.
39 v0.0.2 - Correct labelling issue on reverse strand.
40 - Use the new <stdio> settings in the XML wrappers to catch errors
35 41
36 42
37 Developers 43 Developers
38 ========== 44 ==========
39 45
41 http://bitbucket.org/peterjc/galaxy-central/src/tools 47 http://bitbucket.org/peterjc/galaxy-central/src/tools
42 48
43 For making the "Galaxy Tool Shed" http://community.g2.bx.psu.edu/ tarball use 49 For making the "Galaxy Tool Shed" http://community.g2.bx.psu.edu/ tarball use
44 the following command from the Galaxy root folder: 50 the following command from the Galaxy root folder:
45 51
46 tar -czf get_orfs_or_cdss.tar.gz tools/filters/get_orfs_or_cdss.* 52 tar -czf get_orfs_or_cdss.tar.gz tools/filters/get_orfs_or_cdss.* test-data/get_orf_input*.fasta
47 53
48 Check this worked: 54 Check this worked:
49 55
50 $ tar -tzf get_orfs_or_cdss.tar.gz 56 $ tar -tzf get_orfs_or_cdss.tar.gz
51 filter/get_orfs_or_cdss.py 57 filter/get_orfs_or_cdss.py
52 filter/get_orfs_or_cdss.txt 58 filter/get_orfs_or_cdss.txt
53 filter/get_orfs_or_cdss.xml 59 filter/get_orfs_or_cdss.xml
60 test-data/get_orf_input.Suis_ORF.nuc.fasta
61 test-data/get_orf_input.Suis_ORF.prot.fasta
62 test-data/get_orf_input.t11_nuc_out.fasta
63 test-data/get_orf_input.t11_open_nuc_out.fasta
64 test-data/get_orf_input.t11_open_prot_out.fasta
65 test-data/get_orf_input.t11_prot_out.fasta
66 test-data/get_orf_input.t1_nuc_out.fasta
67 test-data/get_orf_input.t1_prot_out.fasta
54 68
55 69
56 Licence (MIT/BSD style) 70 Licence (MIT/BSD style)
57 ======================= 71 =======================
58 72