Git Product home page Git Product logo

salmid's Introduction

DOI

SalmID

Rapid tool to check taxonomic ID of single isolate samples. Currently only IDs Salmonella species and subspecies, and some common contaminants (Listeria, Escherichia).

Requirements:

Python 3

Installation:

The easy way with homebrew (Linux or MacOS):

brew install brewsci/bio/salmid

Big thanks to Torsten Seemann for including this in homebrew!

Alternatively download from GitHub:

git clone https://github.com/hcdenbakker/SalmID.git

build a wheel using poetry:

cd SalmID
poetry build

and install using pip

pip install dist/salmid*.whl

To execute:

SalmID.py -e .fastq.gz

This will perform a SalmID run on all fastq.gz files in the current directory.

SalmID.py -i your_fastq_gz.fastq.gz

This will perform a SalmID run on an individual file (i.e., your_fastq_gz.fastq.gz)

SalmID.py -d directory_with_data -e _1.fastq.gz

This will perform a SalmID run on all files in directory 'directory_with_data' with extension '_1.fastq.gz'

Todo's and thoughts for future releases:

  • Provide coverage estimates for genomes in sample based on kmer frequencies
  • Write code to use SalmID on long read (minion, pacbio) platforms

salmid's People

Contributors

hcdenbakker avatar pvanheus avatar shaokangzhang avatar

Stargazers

 avatar Lauren Hudson avatar Alex Myczko avatar Curtis Kapsak avatar Thanh Lee avatar Dechun Lin avatar  avatar

Watchers

Lee Katz avatar James Cloos avatar  avatar  avatar Blake A. Dinsmore avatar

salmid's Issues

version 0.11 reports 0.1

SalmID.py --version
SalmID.py 0.1

I used the tarball release 0.11 - maybe the patch to version.py happened later?

No parameters prints table header

% SalmID.py

file    Listeria sensu stricto (rpoB)   L. monocytogenes (rpoB) Escherichia spp. (rpoB) S. bongori (rpoB)       S. enterica(rpoB)       S. bongori (invA)       subsp. I (invA) subsp. II (clade a: invA)      subsp. II (clade b: invA)        subsp. IIIa (invA)      subsp. IIIb (invA)      subsp.IV (invA) subsp. VI (invA)        subsp. VII (invA)       subsp. II (clade VIII : invA)

Maybe print the --help if no input files?

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.