Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ebedthan/hkgfinder

Find housekeeping genes in prokaryotic (meta)genomic data
https://github.com/ebedthan/hkgfinder

bioinformatics housekeeping-genes

Last synced: about 1 month ago
JSON representation

Find housekeeping genes in prokaryotic (meta)genomic data

Host: GitHub
URL: https://github.com/ebedthan/hkgfinder
Owner: Ebedthan
License: mit
Created: 2022-05-27T12:55:41.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-07-25T06:04:36.000Z (over 1 year ago)
Last Synced: 2024-04-25T00:01:42.770Z (7 months ago)
Topics: bioinformatics, housekeeping-genes
Language: Python
Homepage:
Size: 15.2 MB
Stars: 9
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # hkgfinder

*Find housekeeping genes in prokaryotic (meta)genomes*

[![PyPI](https://img.shields.io/pypi/v/hkgfinder.svg)](https://pypi.org/project/hkgfinder)

[![Wheel](https://img.shields.io/pypi/wheel/hkgfinder.svg)](https://pypi.org/project/hkgfinder)

[![Language](https://img.shields.io/pypi/implementation/hkgfinder)](https://pypi.org/project/hkgfinder)

[![Pyver](https://img.shields.io/pypi/pyversions/hkgfinder.svg)](https://pypi.org/project/hkgfinder)

[![Downloads](https://img.shields.io/pypi/dm/hkgfinder)](https://pypi.org/project/hkgfinder)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://www.gnu.org/licenses/MIT)

## 🗺️ Overview

hkgfinder is a fast and accurate housekeeping gene finder and classifier. hkgfinder can run on raw sequences, genomes and metagenomes. The novel value of this method lies is in its ability to directly predict and classify gene sequences into housekeeping gene families at a high specificity and sensitivity, while being also faster than genome and metagenome annotator on genome and metagenome data.

## How hkgfinder works

![](img/hkgfinder.png)

## 🔧 Installing

hkgfinder can be installed directly from [PyPI](https://pypi.org/project/hkgfinder).

```console

$ pip install hkgfinder

```

## Test

* Type `hkgfinder -h` and it should output something like:

```

usage: hkgfinder [options] []

options:

  -o [FILE]      output result to FILE [stdout]

  -g             activate genome mode [false]

  -m             activate metagenome mode [false]

  --faa FILE     output matched protein sequences to FILE [false]

  --fna FILE     output matched DNA sequences to FILE [false]

  -s             output sequences in file by gene [false]

  -t INT         number of threads [1]

  -q             decrease program verbosity

  -d             enable debug mode

  -v, --version  show program's version number and exit

  -h, --help     show this help message and exit

```

## Invoking hkgfinder

```

hkgfinder --faa housekeeping.faa --fna housekeeping.fna file.fa.gz

```

* hkgfinder supports gzip, lzma, bz2 and zstd compressed files.

  

## ⚠️ Issue Tracker

Found a bug ? Have an enhancement request ? Head over to the [Issue Tracker](https://github.com/Ebedthan/hkgfinder/issues) if you need to report

or ask something. If you are filing in on a bug, please include as much

information as you can about the issue, and try to recreate the same bug

in a simple, easily reproducible situation.

## ⚖️ License

[MIT](https://github.com/Ebedthan/hkgfinder/blob/main/LICENSE).

## Author

* [Anicet Ebou](https://orcid.org/0000-0003-4005-177X)