annotate readme.rst @ 6:e6e6f5f9b9c4 draft default tip

planemo upload for repository https://bitbucket.org/crs4/orione-tools/src/bb-orione-tools/custom/edge_pro/ commit 02541df6373bc61be0cdc0617c8549cf8b49b832
author crs4
date Thu, 31 Aug 2017 12:54:08 -0400
parents d5464c9e1723
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
1 EDGE-pro wrapper
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
2 ================
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
3
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
4 Dependencies of EDGE-pro which need to be installed separetely
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
5 --------------------------------------------------------------
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
6
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
7 - Switch_ Perl module.
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
8
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
9 .. _Switch: http://search.cpan.org/~rgarcia/Switch/Switch.pm
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
10
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
11 Configuration
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
12 -------------
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
13
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
14 edge_pro tool may be configured to use more than one CPU core by selecting an appropriate destination for this tool in Galaxy job_conf.xml file (see https://wiki.galaxyproject.org/Admin/Config/Jobs and https://wiki.galaxyproject.org/Admin/Config/Performance/Cluster ).
1
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
15
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
16 If you are using Galaxy release_2013.11.04 or later, this tool will automatically use the number of CPU cores allocated by the job runner according to the configuration of the destination selected for this tool.
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
17
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
18 If instead you are using an older Galaxy release, you should also add a line
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
19
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
20 GALAXY_SLOTS=N; export GALAXY_SLOTS
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
21
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
22 (where N is the number of CPU cores allocated by the job runner for this tool) to the file
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
23
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
24 <tool_dependencies_dir>/edge-pro/1.3.1/crs4/edge_pro/<hash_string>/env.sh
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
25
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
26 Version history
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
27 ---------------
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
28
4
d5464c9e1723 Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents: 3
diff changeset
29 - Release 4: Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
3
ddcbf8732706 Fix edge-pro tool dependency (uninstall and install again the tool dependency if you were encountering errors like &#39;Can&#39;t exec &#34;./bowtie2-build&#34;: No such file or directory&#39;). Update Orione citation.
crs4
parents: 2
diff changeset
30 - Release 3: Fix edge-pro tool dependency (uninstall and install again the tool dependency if you were encountering errors like 'Can't exec "./bowtie2-build": No such file or directory'). Update Orione citation.
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
31 - Release 2: Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
1
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
32 - Release 1: Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
33 - Release 0: Initial release in the Tool Shed.
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
34
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
35 Development
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
36 -----------
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
37
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents:
diff changeset
38 Development is hosted at https://bitbucket.org/crs4/orione-tools . Contributions and bug reports are very welcome!