Skip to content

Commit

Permalink
modified format/header of README and TUTORIAL
Browse files Browse the repository at this point in the history
  • Loading branch information
Ka Ming Nip committed Jul 18, 2014
1 parent 5ce9490 commit 23436ca
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 19 deletions.
31 changes: 18 additions & 13 deletions README.txt
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
Trans-ABySS - de novo assembler for RNAseq data
Trans-ABySS - de novo assembly of RNAseq data using ABySS.

Ka Ming Nip <kmnip@bcgsc.ca>, Readman Chiu <rchiu@bcgsc.ca>, Anthony Raymond <traymond@bcgsc.ca>
Canada's Michael Smith Genome Sciences Centre, BC Cancer Agency
Copyright 2014 Canada's Michael Smith Genome Sciences Centre, BC Cancer Agency

Please use our Google Group <trans-abyss@googlegroups.com> for bug reports, questions, and support.
Existing topics can be viewed at <https://groups.google.com/d/forum/trans-abyss>
Please use our Google Group <trans-abyss@googlegroups.com> for discussions and
support. Existing topics can be viewed at:
<https://groups.google.com/d/forum/trans-abyss>

You may also create issues on our GitHub repository at:
<https://github.com/bcgsc/transabyss/issues>

~ README ~
==================================================================================================
~ README ~
================================================================================
VERSION 1.5.1 (July 18, 2014)

+ Support strand-specific RNAseq data.
+ Major improvement in assembly quality; both rare and common transcripts can be assembled well
with "small" k-mer sizes (ie. 25~32).
+ Major improvement in assembly quality; both rare and common transcripts can be
assembled well with "small" k-mer sizes (ie. 25~32).
+ Package has been divided into 3 main applications:
(1) transabyss - RNAseq assembler at a single k-mer size
(2) transabyss-merge - merge multiple assemblies from (1)
(3) transabyss-analyze - analyze an assembly, either from (1) or (2), for structural variants
and novel splice variants
(3) transabyss-analyze - analyze an assembly, either from (1) or (2), for
structural variants and novel splice variants
- Analysis results are NOT screened against dbSNP, DGV, etc. anymore.
- Genome assembly and analyses pipeline has been retracted.
- Support for SGE qmake has been retracted.
Expand All @@ -38,7 +42,8 @@ Program requirements for 'transabyss-analyze':
* Samtools <http://sourceforge.net/projects/samtools/files/samtools/>
* reference genome and annotations for the organism of interest

Required Python packages (python-igraph, Pysam, BioPython) can be installed easily with pip, ie.
Required Python packages (python-igraph, Pysam, BioPython) can be installed
easily with pip, ie.

pip install igraph
pip install pysam
Expand All @@ -57,5 +62,5 @@ To test `transabyss-analyze' on our sample dataset:
Please see TUTORIAL.txt for more information on the usage of each application.


==================================================================================================
~ EOF ~
================================================================================
~ EOF ~
8 changes: 2 additions & 6 deletions TUTORIAL.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
Trans-ABySS - de novo assembler for RNAseq data
Trans-ABySS - de novo assembly of RNAseq data using ABySS.

Ka Ming Nip <kmnip@bcgsc.ca>, Readman Chiu <rchiu@bcgsc.ca>, Anthony Raymond <traymond@bcgsc.ca>
Canada's Michael Smith Genome Sciences Centre, BC Cancer Agency

Please use our Google Group <trans-abyss@googlegroups.com> for bug reports, questions, and support.
Existing topics can be viewed at <https://groups.google.com/d/forum/trans-abyss>
Copyright 2014 Canada's Michael Smith Genome Sciences Centre, BC Cancer Agency

~ TUTORIAL ~
==================================================================================================
Expand Down

0 comments on commit 23436ca

Please sign in to comment.