Skip to content

An FM-index based tool for the rapid search of variants/sequences within unmapped read sets.

Notifications You must be signed in to change notification settings

wassermanlab/OpenFlexTyper

Repository files navigation

FlexTyper

Generate Documentation License: MIT

Overview

FlexTyper is a tool which enables the creation of an FM-index of raw, next generation sequencing data to enable rapid and flexible sequence queries.

We demonstrate the utility of these flexible queries performed as kmer (sequence substrings of length 'k') searches for two applications including SNP genotyping from whole genome sequencing, and viral detection from RNA-seq.

To learn more about FlexTyper, see our preprint on bioRxiv:

Demonstrating the utility of flexible sequence queries against indexed short reads with FlexTyper

Full Documentation

For more information about FlexTyper, please refer to GitHubPages

Quick start installation

OpenFlexTyper is installed with the install.sh script provided in the repository. Installation is currently supported for Linux operating systems.

The installation assumes that you have git installed.

Open a terminal and enter :

git clone https://github.com/wassermanlab/OpenFlexTyper.git
cd OpenFlexTyper
bash install.sh

Example

This repository comes with an example to test-run your installation and familiarize yourself with the usage of FlexTyper.

You can learn more about examples here

Customizing Query Files

To design query files, follow the instructions in the fmformatter directory here

Downstream Processing

The output files from FlexTyper can be formatted into commonly used formats, e.g. VCF format with a basic genotyping methods.

To learn more, see the fmformatter directory here

Contributers

Alice Kaye | Phillip Richmond | Jacques Kounkou | Tamar Av-Shalom

License

The MIT License (MIT)

Copyright (c) 2020, Wasserman lab

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

An FM-index based tool for the rapid search of variants/sequences within unmapped read sets.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •