annotate README @ 1:ea2528fd7bad draft

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