Giter Site home page Giter Site logo

biospectra's Introduction

biospectra

BioSpectra: A Metagenomic Read Classification System

BUILD

System Requirements: Java 1.7.0, Ant

This code uses "Ant" build system for compilation. So you may need to install "Ant" build system before you start compilation. Please type "ant" in the root of this package (where "build.xml" exists).

Jar package will be generated under "/dist" path. All dependencies(lucene 4.0) will also be copied to "/dist/lib" path after the compilation.

EXECUTION

Index Construction

biospectra_indexing.sh <path_to_reference_FASTA_files> <path_of_index>

BioSpectra accepts input FASTA path as a directory. In this case, BioSpectra will recursively find all FASTA files and process.

Classification

biospectra_classify.sh <path_of_index> <path_to_query_FASTA_files> <path_to_output_dir>

BioSpectra accepts query FASTA path as a directory. In this case, BioSpectra will recursively find all FASTA files and process. Classification results (in form of json) will be stored as a file with the same filename as input with a extension ".result". Also it automatically generates a summary file that shows timetaken of classifications and total number of "classified", "vague" or "unknown" reads.

BENCHMARK DATASETS

Source package contains a script to download NCBI bacteria reference datasets at /benchmark/down_ncbi_bacteria_reference.sh. To work with this datasets, you will need at least 25GB of disk space including size of generated index form this datasets.

A simulated query datasets extracted from NCBI bacteria reference datasets with fixed error ratio is provided at /benchmark/bacteria_ncbi_simulated directory. For example, a /benchmark/bacteria_ncbi_simulated/sample_0.04.fa file contains reads (each in length about 100) randomly extracted from NCBI bacteria datasets with 4% of sequencing errors at random positions.

Another simulated query datasets extracted from FAMeS(Fidelity of Analysis of Metagenomic Samples) datasets are provided at /benchmark/simHC.20.500 directory. Each file in the directory contains 500 reads that are extracted by a single species (referring a filename).

biospectra's People

Contributors

iychoi avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

biospectra's Issues

Fasta File as a query

Take Fasta file as a query file. So that metagenomic sample file will be taken as an input of search system.

This will output:

  • matching reads : total count, organism, confidence score
  • unknown reads : total count

Optimistic query term drop for kgrams

Drop redundant terms in case described below:
Query: AAAABBBBCCCC (4mers)
to AAAA, AABB, BBBB, BBCC, CCCC
drop AAAB, ABBB, BCCC
when AAAA, AABB, BBBB, BBCC, CCCC returns the same results (meaning no search for dropping kgrams are redundant)

Replace FASTA parser

Current FASTA parser uses String class as a data structure of parsed read.

  • parse "GI" in header
  • handle very long sequence in a read (up to GB scale) using InputStream.

Document scoring

Need to research what scoring function default lucene uses.
Need to optimize it for better performance and confidence.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.