# hkgfinder
*Find housekeeping genes in prokaryotic (meta)genomes*
[](https://pypi.org/project/hkgfinder)
[](https://pypi.org/project/hkgfinder)
[](https://pypi.org/project/hkgfinder)
[](https://pypi.org/project/hkgfinder)
[](https://pypi.org/project/hkgfinder)
[](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
## 🔧 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] [<FILE>]
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)
Raw data
{
"_id": null,
"home_page": "https://github.com/Ebedthan/hkgfinder",
"name": "hkgfinder",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "bioinformatics",
"author": "Anicet Ebou",
"author_email": "anicet.ebou@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/65/fc/c1b80f8eb6b08abe755330f8374ffb701af1670028147df03cbabbeda520/hkgfinder-0.3.0.tar.gz",
"platform": null,
"description": "# hkgfinder\n\n*Find housekeeping genes in prokaryotic (meta)genomes*\n\n[](https://pypi.org/project/hkgfinder)\n[](https://pypi.org/project/hkgfinder)\n[](https://pypi.org/project/hkgfinder)\n[](https://pypi.org/project/hkgfinder)\n[](https://pypi.org/project/hkgfinder)\n[](https://www.gnu.org/licenses/MIT)\n\n\n\n\n## \ud83d\uddfa\ufe0f Overview\nhkgfinder 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.\n\n\n## How hkgfinder works\n\n\n## \ud83d\udd27 Installing\n\nhkgfinder can be installed directly from [PyPI](https://pypi.org/project/hkgfinder).\n\n```console\n$ pip install hkgfinder\n```\n\n## Test\n\n* Type `hkgfinder -h` and it should output something like:\n\n```\nusage: hkgfinder [options] [<FILE>]\n\noptions:\n -o [FILE] output result to FILE [stdout]\n -g activate genome mode [false]\n -m activate metagenome mode [false]\n --faa FILE output matched protein sequences to FILE [false]\n --fna FILE output matched DNA sequences to FILE [false]\n -s output sequences in file by gene [false]\n -t INT number of threads [1]\n -q decrease program verbosity\n -d enable debug mode\n -v, --version show program's version number and exit\n -h, --help show this help message and exit\n```\n\n\n## Invoking hkgfinder\n\n```\nhkgfinder --faa housekeeping.faa --fna housekeeping.fna file.fa.gz\n```\n\n* hkgfinder supports gzip, lzma, bz2 and zstd compressed files.\n \n## \u26a0\ufe0f Issue Tracker\n\nFound a bug ? Have an enhancement request ? Head over to the [Issue Tracker](https://github.com/Ebedthan/hkgfinder/issues) if you need to report\nor ask something. If you are filing in on a bug, please include as much\ninformation as you can about the issue, and try to recreate the same bug\nin a simple, easily reproducible situation.\n\n\n## \u2696\ufe0f License\n\n[MIT](https://github.com/Ebedthan/hkgfinder/blob/main/LICENSE).\n\n\n## Author\n\n* [Anicet Ebou](https://orcid.org/0000-0003-4005-177X)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "find housekeeping genes in prokaryotic (meta)genomic data",
"version": "0.3.0",
"project_urls": {
"Documentation": "https://github.com/Ebedthan/hkgfinder",
"Homepage": "https://github.com/Ebedthan/hkgfinder",
"Repository": "https://github.com/Ebedthan/hkgfinder"
},
"split_keywords": [
"bioinformatics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "42522de24f9d1eea5dfd51d56c9adda663bd19351dcc2d9069e9f63a5aa843d6",
"md5": "de77b9785691069a2517c7608b6320a6",
"sha256": "d9f3f23a79efbe1e22d26d8dbcfcb36ab8fb3af742b9a0dad12f45d24d985927"
},
"downloads": -1,
"filename": "hkgfinder-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "de77b9785691069a2517c7608b6320a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 868327,
"upload_time": "2024-07-08T06:42:16",
"upload_time_iso_8601": "2024-07-08T06:42:16.309035Z",
"url": "https://files.pythonhosted.org/packages/42/52/2de24f9d1eea5dfd51d56c9adda663bd19351dcc2d9069e9f63a5aa843d6/hkgfinder-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "65fcc1b80f8eb6b08abe755330f8374ffb701af1670028147df03cbabbeda520",
"md5": "4ec3f1e521a28f0300b2269136d0cd29",
"sha256": "19e02169aa63f8fec24fe06579806389f405100fa8e0d5e0b209ea628674e2d6"
},
"downloads": -1,
"filename": "hkgfinder-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "4ec3f1e521a28f0300b2269136d0cd29",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 853003,
"upload_time": "2024-07-08T06:42:20",
"upload_time_iso_8601": "2024-07-08T06:42:20.546270Z",
"url": "https://files.pythonhosted.org/packages/65/fc/c1b80f8eb6b08abe755330f8374ffb701af1670028147df03cbabbeda520/hkgfinder-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 06:42:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Ebedthan",
"github_project": "hkgfinder",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "hkgfinder"
}
JSON
