combined-gene-caller


Namecombined-gene-caller JSON
Version 1.0.4 PyPI version JSON
download
home_page
SummaryCombined gene caller for MGnify pipeline, to combine predictions from FragGeneScan and Prodigal
upload_time2023-08-14 13:58:29
maintainer
docs_urlNone
author
requires_python>=3.9
licenseApache Software License 2.0
keywords bioinformatics gene metagenomics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Overview

[![Testing](https://github.com/EBI-Metagenomics/combined-gene-caller/actions/workflows/test.yml/badge.svg)](https://github.com/EBI-Metagenomics/combined-gene-caller/actions/workflows/test.yml)
[![Docker Repository on Quay](https://quay.io/repository/microbiome-informatics/combined-gene-caller/status "Docker Repository on Quay")](https://quay.io/repository/microbiome-informatics/combined-gene-caller)

Combined gene caller for MGnify pipeline, to combine predictions of Prodigal and FragGeneScan.

-   Free software: Apache Software License 2.0

## Installation

```bash
pip install https://github.com/ebi-metagenomics/combined-gene-caller/archive/main.zip
```

## Usage

To use the project:

```bash
combined_gene_caller --help
usage: MGnify gene caller combiner. This script will merge the gene called by prodigal and fraggenescan (in any order) [-h] -n NAME [-k MASK] [-a PRODIGAL_OUT]
                                                                                                                       [-b PRODIGAL_FFN] [-c PRODIGAL_FAA] [-d FGS_OUT]
                                                                                                                       [-e FGS_FFN] [-f FGS_FAA]
                                                                                                                       [-p {prodigal_fgs,fgs_prodigal}] [-v] [--version]

optional arguments:
  -h, --help            show this help message and exit
  -n NAME, --name NAME  basename
  -k MASK, --mask MASK  Sequence mask file
  -a PRODIGAL_OUT, --prodigal-out PRODIGAL_OUT
                        Stats out prodigal
  -b PRODIGAL_FFN, --prodigal-ffn PRODIGAL_FFN
                        Stats ffn prodigal
  -c PRODIGAL_FAA, --prodigal-faa PRODIGAL_FAA
                        Stats faa prodigal
  -d FGS_OUT, --fgs-out FGS_OUT
                        Stats out FGS
  -e FGS_FFN, --fgs-ffn FGS_FFN
                        Stats ffn FGS
  -f FGS_FAA, --fgs-faa FGS_FAA
                        Stats faa FGS
  -p {prodigal_fgs,fgs_prodigal}, --caller-priority {prodigal_fgs,fgs_prodigal}
                        Caller priority.
  -v, --verbose         verbose output
  --version             show program's version number and exit
```

## Development

To run all the tests run:

    pytest

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "combined-gene-caller",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "bioinformatics,gene,metagenomics",
    "author": "",
    "author_email": "MGnify team <metagenomics-help@ebi.ac.uk>",
    "download_url": "https://files.pythonhosted.org/packages/f0/b2/836f76d4856a4c0264138f7c18bc5a29cda40e8791dc1e5a65e21bb8b9ca/combined_gene_caller-1.0.4.tar.gz",
    "platform": null,
    "description": "# Overview\n\n[![Testing](https://github.com/EBI-Metagenomics/combined-gene-caller/actions/workflows/test.yml/badge.svg)](https://github.com/EBI-Metagenomics/combined-gene-caller/actions/workflows/test.yml)\n[![Docker Repository on Quay](https://quay.io/repository/microbiome-informatics/combined-gene-caller/status \"Docker Repository on Quay\")](https://quay.io/repository/microbiome-informatics/combined-gene-caller)\n\nCombined gene caller for MGnify pipeline, to combine predictions of Prodigal and FragGeneScan.\n\n-   Free software: Apache Software License 2.0\n\n## Installation\n\n```bash\npip install https://github.com/ebi-metagenomics/combined-gene-caller/archive/main.zip\n```\n\n## Usage\n\nTo use the project:\n\n```bash\ncombined_gene_caller --help\nusage: MGnify gene caller combiner. This script will merge the gene called by prodigal and fraggenescan (in any order) [-h] -n NAME [-k MASK] [-a PRODIGAL_OUT]\n                                                                                                                       [-b PRODIGAL_FFN] [-c PRODIGAL_FAA] [-d FGS_OUT]\n                                                                                                                       [-e FGS_FFN] [-f FGS_FAA]\n                                                                                                                       [-p {prodigal_fgs,fgs_prodigal}] [-v] [--version]\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -n NAME, --name NAME  basename\n  -k MASK, --mask MASK  Sequence mask file\n  -a PRODIGAL_OUT, --prodigal-out PRODIGAL_OUT\n                        Stats out prodigal\n  -b PRODIGAL_FFN, --prodigal-ffn PRODIGAL_FFN\n                        Stats ffn prodigal\n  -c PRODIGAL_FAA, --prodigal-faa PRODIGAL_FAA\n                        Stats faa prodigal\n  -d FGS_OUT, --fgs-out FGS_OUT\n                        Stats out FGS\n  -e FGS_FFN, --fgs-ffn FGS_FFN\n                        Stats ffn FGS\n  -f FGS_FAA, --fgs-faa FGS_FAA\n                        Stats faa FGS\n  -p {prodigal_fgs,fgs_prodigal}, --caller-priority {prodigal_fgs,fgs_prodigal}\n                        Caller priority.\n  -v, --verbose         verbose output\n  --version             show program's version number and exit\n```\n\n## Development\n\nTo run all the tests run:\n\n    pytest\n",
    "bugtrack_url": null,
    "license": "Apache Software License 2.0",
    "summary": "Combined gene caller for MGnify pipeline, to combine predictions from FragGeneScan and Prodigal",
    "version": "1.0.4",
    "project_urls": null,
    "split_keywords": [
        "bioinformatics",
        "gene",
        "metagenomics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9cc5223566150774731e823e218f4906c4a6020bca9d7bd94be0a4af6584d930",
                "md5": "9ffe626d51fe252ce33e47a78c8ecc10",
                "sha256": "2cfd6ef3c2f032178accbf37469bdb11c967a126011a5f250183dcee02b9a8aa"
            },
            "downloads": -1,
            "filename": "combined_gene_caller-1.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9ffe626d51fe252ce33e47a78c8ecc10",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 11999,
            "upload_time": "2023-08-14T13:58:28",
            "upload_time_iso_8601": "2023-08-14T13:58:28.277308Z",
            "url": "https://files.pythonhosted.org/packages/9c/c5/223566150774731e823e218f4906c4a6020bca9d7bd94be0a4af6584d930/combined_gene_caller-1.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f0b2836f76d4856a4c0264138f7c18bc5a29cda40e8791dc1e5a65e21bb8b9ca",
                "md5": "29c48785d0b005861b05cf9d4e7651bf",
                "sha256": "197c40b986fa9d274e74b08d57844fa94ef56c42719a1af631f5252cbd07c01a"
            },
            "downloads": -1,
            "filename": "combined_gene_caller-1.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "29c48785d0b005861b05cf9d4e7651bf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 12548,
            "upload_time": "2023-08-14T13:58:29",
            "upload_time_iso_8601": "2023-08-14T13:58:29.760110Z",
            "url": "https://files.pythonhosted.org/packages/f0/b2/836f76d4856a4c0264138f7c18bc5a29cda40e8791dc1e5a65e21bb8b9ca/combined_gene_caller-1.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-14 13:58:29",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "combined-gene-caller"
}
        
Elapsed time: 0.12209s