annotate README @ 1:47f068960327 draft default tip

Deleted selected files
author slegras
date Thu, 06 Aug 2015 09:15:42 -0400
parents baf52103977b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
baf52103977b Uploaded
slegras
parents:
diff changeset
1 Galaxy tool definition for cutadapt (http://code.google.com/p/cutadapt/)
baf52103977b Uploaded
slegras
parents:
diff changeset
2
baf52103977b Uploaded
slegras
parents:
diff changeset
3
baf52103977b Uploaded
slegras
parents:
diff changeset
4 Installation - Tool Shed
baf52103977b Uploaded
slegras
parents:
diff changeset
5 ------------------------
baf52103977b Uploaded
slegras
parents:
diff changeset
6
baf52103977b Uploaded
slegras
parents:
diff changeset
7 The recommended way to install cutadapt as a tool in Galaxy is to the use the
baf52103977b Uploaded
slegras
parents:
diff changeset
8 Galaxy Tool Shed (http://wiki.galaxyproject.org/Tool%20Shed).
baf52103977b Uploaded
slegras
parents:
diff changeset
9
baf52103977b Uploaded
slegras
parents:
diff changeset
10 This will allow cutadapt to be installed automatically and keep track of older
baf52103977b Uploaded
slegras
parents:
diff changeset
11 versions of cutadapt and the tool wrapper.
baf52103977b Uploaded
slegras
parents:
diff changeset
12
baf52103977b Uploaded
slegras
parents:
diff changeset
13
baf52103977b Uploaded
slegras
parents:
diff changeset
14 Installation - Manual
baf52103977b Uploaded
slegras
parents:
diff changeset
15 ---------------------
baf52103977b Uploaded
slegras
parents:
diff changeset
16
baf52103977b Uploaded
slegras
parents:
diff changeset
17 1. Install the cutadapt package and make sure it is in path for Galaxy
baf52103977b Uploaded
slegras
parents:
diff changeset
18
baf52103977b Uploaded
slegras
parents:
diff changeset
19 2. Copy cutadapt.xml to $GALAXY_HOME/tools/cutadapt
baf52103977b Uploaded
slegras
parents:
diff changeset
20
baf52103977b Uploaded
slegras
parents:
diff changeset
21 3. Add the tool to the $GALAXY_HOME/tool_conf.xml tool-registry file
baf52103977b Uploaded
slegras
parents:
diff changeset
22
baf52103977b Uploaded
slegras
parents:
diff changeset
23 **Optional steps to setup and run Galaxy functional tests**
baf52103977b Uploaded
slegras
parents:
diff changeset
24
baf52103977b Uploaded
slegras
parents:
diff changeset
25 4. Copy test-data/* to $GALAXY_HOME/test-data/
baf52103977b Uploaded
slegras
parents:
diff changeset
26
baf52103977b Uploaded
slegras
parents:
diff changeset
27 5. Set GALAXY_TEST_TOOL_CONF environment variable to a tool_conf.xml file that
baf52103977b Uploaded
slegras
parents:
diff changeset
28 contains the tools you want to test. (e.g. 'tool_conf.xml')
baf52103977b Uploaded
slegras
parents:
diff changeset
29
baf52103977b Uploaded
slegras
parents:
diff changeset
30 6. $GALAXY_HOME/run_functional_tests.sh -id cutadapt
baf52103977b Uploaded
slegras
parents:
diff changeset
31 See the Galaxy Wiki for more information: http://wiki.g2.bx.psu.edu/
baf52103977b Uploaded
slegras
parents:
diff changeset
32
baf52103977b Uploaded
slegras
parents:
diff changeset
33
baf52103977b Uploaded
slegras
parents:
diff changeset
34 Configuration of Adapters
baf52103977b Uploaded
slegras
parents:
diff changeset
35 -------------------------
baf52103977b Uploaded
slegras
parents:
diff changeset
36
baf52103977b Uploaded
slegras
parents:
diff changeset
37 A list of predefined adapters may be specified in the cutadapt_adapters.txt
baf52103977b Uploaded
slegras
parents:
diff changeset
38 file which resides in the tool-data directory underneath the Galaxy root. A sample
baf52103977b Uploaded
slegras
parents:
diff changeset
39 file is provided.
baf52103977b Uploaded
slegras
parents:
diff changeset
40
baf52103977b Uploaded
slegras
parents:
diff changeset
41
baf52103977b Uploaded
slegras
parents:
diff changeset
42 Limitations of the Galaxy wrapper
baf52103977b Uploaded
slegras
parents:
diff changeset
43 ---------------------------------
baf52103977b Uploaded
slegras
parents:
diff changeset
44
baf52103977b Uploaded
slegras
parents:
diff changeset
45 Reading adapters from a fasta file is not supported
baf52103977b Uploaded
slegras
parents:
diff changeset
46 Colorspace data support is not implemented
baf52103977b Uploaded
slegras
parents:
diff changeset
47 Only one "Strip suffix" is suppored
baf52103977b Uploaded
slegras
parents:
diff changeset
48
baf52103977b Uploaded
slegras
parents:
diff changeset
49
baf52103977b Uploaded
slegras
parents:
diff changeset
50 Galaxy Wrapper Development
baf52103977b Uploaded
slegras
parents:
diff changeset
51 --------------------------
baf52103977b Uploaded
slegras
parents:
diff changeset
52
baf52103977b Uploaded
slegras
parents:
diff changeset
53 Author: Lance Parsons <lparsons@princeton.edu>
baf52103977b Uploaded
slegras
parents:
diff changeset
54
baf52103977b Uploaded
slegras
parents:
diff changeset
55 Repository: [https://bitbucket.org/lance_parsons/cutadapt\_galaxy\_wrapper](https://bitbucket.org/lance_parsons/cutadapt_galaxy_wrapper)