Mercurial > repos > crs4 > bwa_mem

annotate readme.rst @ 1:ebb02ba5987c draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Rewrite of param handling. interPairEnd param moved to "paired" section. Add param for '-a' option. Remove basic parallelism tag, which does not work with multiple inputs (thanks Bjoern Gruening for the notice). Simplify Python code.
author crs4
date Fri, 21 Mar 2014 12:56:15 -0400
parents 6820983ba5d5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
1 BWA-MEM wrapper
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
2 ===============
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
3
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
4 This is a wrapper for BWA_, a software package for mapping low-divergent sequences against a large reference genome. This wrapper supports only the latest algorithm, BWA-MEM, which is generally recommended for high-quality queries as it is faster and more accurate. BWA-MEM also has better performance than BWA-backtrack for 70-100bp Illumina reads.
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
5
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
6 .. _BWA: http://bio-bwa.sourceforge.net/
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
7
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
8 If you need a wrapper for the old BWA-backtrack algorithm, you may install http://toolshed.g2.bx.psu.edu/view/devteam/bwa_wrappers repository.
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
9
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
10 Configuration
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
11 -------------
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
12
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
13 bwa_mem 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 ).
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
14
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
15 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.
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
16
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
17 If instead you are using an older Galaxy release, you should also add a line
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
18
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
19 GALAXY_SLOTS=N; export GALAXY_SLOTS
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
20
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
21 (where N is the number of CPU cores allocated by the job runner for this tool) to the file
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
22
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
23 <tool_dependencies_dir>/bwa/0.7.7/crs4/bwa_mem/<hash_string>/env.sh
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
24
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
25 Version history
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
26 ---------------
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
27
1
ebb02ba5987c Rewrite of param handling. interPairEnd param moved to "paired" section. Add param for '-a' option. Remove basic parallelism tag, which does not work with multiple inputs (thanks Bjoern Gruening for the notice). Simplify Python code.
crs4
parents: 0
diff changeset
28 - Release 1 (bwa_mem 0.8.0): Rewrite of param handling. interPairEnd param moved to "paired" section. Add param for '-a' option. Remove basic parallelism tag, which does not work with multiple inputs (thanks Björn Grüning for the notice). Simplify Python code.
ebb02ba5987c Rewrite of param handling. interPairEnd param moved to "paired" section. Add param for '-a' option. Remove basic parallelism tag, which does not work with multiple inputs (thanks Bjoern Gruening for the notice). Simplify Python code.
crs4
parents: 0
diff changeset
29 - Release 0 (bwa_mem 0.7.7): Initial release in the Tool Shed. This is a fork of http://toolshed.g2.bx.psu.edu/view/yufei-luo/bwa_0_7_5 repository with the following changes: Remove .loc file, only .loc.sample should be included. Fix bwa_index.loc.sample file to contain only comments. Add suppressHeader param as in bwa_wrappers. Use $GALAXY_SLOTS environment variable when available. Add <version_command> and <help>. Remove unused import. Fix spacing and typos. Use new recommended citation. Add tool_dependencies.xml . Rename to bwa_mem. Remove definitively colorspace support. Use optparse instead of argparse since Galaxy still supports Python 2.6 . Add COPYING and readme.rst files.
0
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
30
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
31 Development
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
32 -----------
6820983ba5d5 Uploaded
crs4
parents:
diff changeset
33
1
ebb02ba5987c Rewrite of param handling. interPairEnd param moved to "paired" section. Add param for '-a' option. Remove basic parallelism tag, which does not work with multiple inputs (thanks Bjoern Gruening for the notice). Simplify Python code.
crs4
parents: 0
diff changeset
34 Development is hosted at https://bitbucket.org/crs4/orione-tools . Contributions and bug reports are very welcome!