Skip to content

Commit

Permalink
Edit README md
Browse files Browse the repository at this point in the history
  • Loading branch information
bhatarchanas committed Nov 3, 2016
1 parent c9dcf61 commit 33772c0
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
Introduction:

Lineanator uses USEARCH and NCBI to create a database file with confidences up to the species level.
This database file can be used in MC-SMRT to assign taxonomy and confidences to OTUs in a microbiome community.


Installation and Dependencies:

1) Ruby gems such as bio, troloop and nokogiri are required for Lineanator to function. Use the "gem install {name_of_the_gem}" command to install these gems.
2) Download and install usearch v8.1.
Create a soft link pointing towards this version of usearch and name it "usearch". The soft link name HAS TO BE usearch, this is VERY IMPORTANT.


Usage:

ruby lineanator.rb [-h] [-d DUMP_FILE] [-s SEQ_FILE] [-t TAB_DELIMITED_LINEAGE_OUTPUT_FILE] [-f FASTA_LINEAGE_OUTPUT_FILE] [-p PLACE_HOLDER_NAMES_FILE]


Arguments explained:

1) DUMP_FILE - This text file serves as a source to map between the gi id's in the SEQ_FILE and get the tax id's corresponding to each gi id.
The dump file we used was taken from NCBI's taxonomy FTP (ftp://ftp.ncbi.nlm.nih.gov/pub/taxonomy/).
The directory called gi_taxid_nucl.zip in the FTP had a file with gi id in the first column and tax id in the second column (no headers).
Expand All @@ -33,6 +37,7 @@ Arguments explained:


Output files:

Two of the output files are the ones which you gave as arguments to lineanator, these are expalined above.

The basename of the FASTA_LINEAGE_OUTPUT_FILE given by you is used for creating other files using USEARCH commands.
Expand All @@ -43,4 +48,5 @@ For example, if the name of your FASTA_LINEAGE_OUTPUT_FILE is "16sMicrobial_ncbi


Built with:

ruby 2.2.1p85 (2015-02-26 revision 49769) [x86_64-linux]

0 comments on commit 33772c0

Please sign in to comment.