traits_finder
Introduction
- traits_finder searches and summarizes traits in genomes and metagenomes
- input: reference database and folder of genomes/metagenomes
- requirement: python >= 3.0, blast or hmm
- requirement: for hmm, you need to prepare the hmm database
- optional: diamond, bwa, hs-blastn, usearch, mafft, fasttree
Install
pip install traits_finder
in preparation: anaconda download caozhichongchong/traits_finder
latest version (unstable though)
git clone https://github.com/caozhichongchong/traits_finder.git
cd traits_finder
python setup.py build
python setup.py install
Availability
https://pypi.org/project/traits_finder
What do you need to prepare
- your reference database (-db your.db), protein sequences (-dbf 1) or dna sequences (-dbf 2)
- a mapping file of functions to each reference sequence (sequence function)
- all genomes/metagenomes in a folder (-i your.input.folder)
- suffix or file extension of your genomes/metagenomes, such as .fasta or .fastq (-fa your.input.genome/metagenome.format)
- programs to run: blast for similarity search (-s 1 )or hmm for domain search (-s 2)
- optional programs to speedup! diamond, hs-blastn (or usearch for 16S extracting), usearch (necessary for HGT and HGT_sum)
- optional programs to look at sequence variants! bwa, mafft, fasttree
How to use it
Search traits: boring and slow...
Database installed in traits_finder: antibiotic resistant genes (-db ARG), butyrate producing genes (-db but)
-
search protein reference sequences in genomes (traits_finder genome) or mobile genetic elements (traits_finder mge) by similarity search
traits_finder genome -db your.db -i your.input.folder -fa your.input.genome.format --orf your.input.orf.format --r your.output.folder --r16 your.output.folder.for.16s --u diamond --bp blastp -dbf 1 -s 1\ -
search protein reference sequences in metagenomes by similarity search
traits_finder meta -db your.db -i your.input.folder -fa your.input.metagenomes.format --r your.output.folder --r16 your.output.folder.for.16s --u diamond --bp blastp -dbf 1 -s 1\ -
search dna reference sequences in genomes by similarity search
traits_finder genome -db your.db -i your.input.folder -fa your.input.genome.format --orf your.input.orf.format --r your.output.folder --r16 your.output.folder.for.16s --u usearch.or.hs-blastn --bp blastn -dbf 2 -s 1\ -
search dba reference sequences in metagenomes by similarity search
traits_finder meta -db your.db -i your.input.folder -fa your.input.metagenomes.format --r your.output.folder --r16 your.output.folder.for.16s --u usearch.or.hs-blastn --bp blastn -dbf 2 -s 1\ -
search protein reference sequences in genomes by hmm
traits_finder genome -db your.db -i your.input.folder -fa your.input.genome.format --orf your.input.orf.format --r your.output.folder --r16 your.output.folder.for.16s --hmm hmmscan -dbf 1 -s 2\ -
search dna reference sequences in genomes by alignment
traits_finder genome -db your.db -i your.input.folder -fa your.input.genome.format --orf your.input.orf.format --r your.output.folder --r16 your.output.folder.for.16s --u usearch.or.hs-blastn --bp blastn --bwa bwa -dbf 2 -s 1\ -
search dna reference sequences in metagenomes by alignment
traits_finder meta -db your.db -i your.input.folder -fa your.input.metagenomes.format --r your.output.folder --r16 your.output.folder.for.16s --u usearch.or.hs-blastn --bp blastn --bwa bwa -dbf 2 -s 1\
Summarize results: cool and fast!
-
summarize traits in genome
traits_finder sum_genome -db your.db -m function.mapping.your.db -i your.input.folder -fa your.input.genome.format --orf your.input.orf.format --r your.output.folder --r16 your.output.folder.for.16s\ -
summarize traits in metagenomes
traits_finder sum_meta -db your.db -m function.mapping.your.db -i your.input.folder -fa your.input.metagenomes.format --r your.output.folder --r16 your.output.folder.for.16s --meta metadata.txt\
HGT finder and summarizing: cool and fast! (still-testing)
Results
Copyright
Copyright: An Ni Zhang, Prof. Eric Alm, Alm Lab in MIT
Citation: Not yet, coming soon!
Contact: anniz44@mit.edu
Metadata
Release files for traits-finder 1.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| traits_finder-1.6.tar.gz | 4.7 MB | Without provenance | Details for traits_finder-1.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| traits_finder-1.6-py3.6.egg | Legacy Egg format | - | - | Details for traits_finder-1.6-py3.6.egg |
Total release size: 9.7 MB
Release files / traits_finder-1.6.tar.gz
| Download URL | traits_finder-1.6.tar.gz |
|---|---|
| Size | 4.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ea30a6745418abfd7814942053cc84d4700e2b0bdc3770044688fcc14d03f91f
|
|
BLAKE2b-256 checksum How to use checksums |
b2371127f8b62abf4957ab78fc410d10a516f468a6557cd815f438528686b734
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.32.2 CPython/3.6.7
|
Release files / traits_finder-1.6-py3.6.egg
| Download URL | traits_finder-1.6-py3.6.egg |
|---|---|
| Size | 5.0 MB |
| Tags | Egg |
|
SHA-256 checksum How to use checksums |
24a217d362ed7eabf4aebb72214a71863c3dc6089e647e15cbec75a13285b340
|
|
BLAKE2b-256 checksum How to use checksums |
ff081e8cf043964ee7a7037def01e71321ba3358926bb57d7d96d6bd4f6797e0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.32.2 CPython/3.6.7
|
Security for traits-finder 1.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.