Better FASTA Grep
-----------------
<img src="https://gitlab.com/fethalen/bfg/raw/master/images/bfg.png" alt="BFG logo - a pair of binoculars" align="right" width = "20%"/>
Better FASTA Grep, or BFG for short, is a Grep-like utility for retrieving
matching sequence records from a FASTA file. Given one or more patterns and a
FASTA file, it searches the file for matching headers and or sequences and
outputs any matching headers, sequences, or both.
## Features
* Search headers, sequences, or both
* Search via regular expressions or plain strings
* Case-insensitive search
* Select non-matching sequence records
* Count the number of matches
* Display line numbers in the result
* Sequence records, not individual lines, are selected
* Multi-line sequences are treated as singular units
* Flexible output options: output headers, sequences, or both
<img src="https://gitlab.com/fethalen/bfg/raw/master/images/bfg_screenshot_1.png" alt="BFG Screenshot" />
A screenshot of running BFG under macOS Mojave.
## Quick installation
The easiest way to install this program is via `pip`:
```bash
pip install better_fasta_grep
```
You can then launch `bfg` using _one_ of the following commands:
```bash
bfg --help
better_fasta_grep --help # equivalent
```
## [Documentation](https://github.com/fethalen/better_fasta_grep/wiki)
1. [Introduction](https://github.com/fethalen/better_fasta_grep/wiki#1-introduction)
2. [Installation](https://github.com/fethalen/better_fasta_grep/wiki#2-installation)
3. [Invoking `bfg`](https://github.com/fethalen/better_fasta_grep/wiki#3-invoking-bfg)
4. [Regular Expressions](https://github.com/fethalen/better_fasta_grep/wiki#4-regular-expressions)
5. [Input Data](https://github.com/fethalen/better_fasta_grep/wiki#5-input-data)
6. [Usage](https://github.com/fethalen/better_fasta_grep/wiki#6-usage)
© Department for Animal Evolution and Biodiversity 2019
Raw data
{
"_id": null,
"home_page": "https://github.com/fethalen/better_fasta_grep",
"name": "better-fasta-grep",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "bioinformatics,fasta,grep,regular-expressions,bioinformatics-tool,grep-like",
"author": "Felix Thalen, Clemens Mauksch",
"author_email": "felix.thalen@uni-goettingen.de, clemens.mauksch@uni-goettingen.de",
"download_url": "https://files.pythonhosted.org/packages/cf/35/fbdf454f213416fde4f7b31f30096f888546f733c78fe5c53d4dc1828234/better_fasta_grep-1.0.4.tar.gz",
"platform": null,
"description": "Better FASTA Grep\n-----------------\n\n<img src=\"https://gitlab.com/fethalen/bfg/raw/master/images/bfg.png\" alt=\"BFG logo - a pair of binoculars\" align=\"right\" width = \"20%\"/>\n\nBetter FASTA Grep, or BFG for short, is a Grep-like utility for retrieving\nmatching sequence records from a FASTA file. Given one or more patterns and a\nFASTA file, it searches the file for matching headers and or sequences and\noutputs any matching headers, sequences, or both.\n\n## Features\n\n* Search headers, sequences, or both\n* Search via regular expressions or plain strings\n* Case-insensitive search\n* Select non-matching sequence records\n* Count the number of matches\n* Display line numbers in the result\n* Sequence records, not individual lines, are selected\n* Multi-line sequences are treated as singular units\n* Flexible output options: output headers, sequences, or both\n\n<img src=\"https://gitlab.com/fethalen/bfg/raw/master/images/bfg_screenshot_1.png\" alt=\"BFG Screenshot\" />\n\nA screenshot of running BFG under macOS Mojave.\n\n## Quick installation\n\nThe easiest way to install this program is via `pip`:\n\n```bash\npip install better_fasta_grep\n```\n\nYou can then launch `bfg` using _one_ of the following commands:\n\n```bash\nbfg --help\nbetter_fasta_grep --help # equivalent\n```\n\n## [Documentation](https://github.com/fethalen/better_fasta_grep/wiki)\n\n1. [Introduction](https://github.com/fethalen/better_fasta_grep/wiki#1-introduction)\n2. [Installation](https://github.com/fethalen/better_fasta_grep/wiki#2-installation)\n3. [Invoking `bfg`](https://github.com/fethalen/better_fasta_grep/wiki#3-invoking-bfg)\n4. [Regular Expressions](https://github.com/fethalen/better_fasta_grep/wiki#4-regular-expressions)\n5. [Input Data](https://github.com/fethalen/better_fasta_grep/wiki#5-input-data)\n6. [Usage](https://github.com/fethalen/better_fasta_grep/wiki#6-usage)\n\n\u00a9 Department for Animal Evolution and Biodiversity 2019\n\n\n",
"bugtrack_url": null,
"license": "GPL 3",
"summary": "Grep-like tool for retrieving matching sequence records from a FASTA file",
"version": "1.0.4",
"split_keywords": [
"bioinformatics",
"fasta",
"grep",
"regular-expressions",
"bioinformatics-tool",
"grep-like"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cf35fbdf454f213416fde4f7b31f30096f888546f733c78fe5c53d4dc1828234",
"md5": "4050515527941c91f9200fd00b9ac0b6",
"sha256": "e316f3cef579359aac23c59ae6e3add083b157288c012f52cf5fd85339cb524b"
},
"downloads": -1,
"filename": "better_fasta_grep-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "4050515527941c91f9200fd00b9ac0b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 148816,
"upload_time": "2023-03-24T11:39:53",
"upload_time_iso_8601": "2023-03-24T11:39:53.830112Z",
"url": "https://files.pythonhosted.org/packages/cf/35/fbdf454f213416fde4f7b31f30096f888546f733c78fe5c53d4dc1828234/better_fasta_grep-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-24 11:39:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "fethalen",
"github_project": "better_fasta_grep",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "better-fasta-grep"
}
JSON
