gtdb-precurate


Namegtdb-precurate JSON
Version 1.0.2 PyPI version JSON
download
home_pagehttps://github.com/Ecogenomics/gtdb_precurate
SummaryAutomatic pre-curation of GTDB trees.
upload_time2023-12-12 23:50:58
maintainerAaron Mussig
docs_urlNone
authorAaron Mussig
requires_python>=3.8
licenseGPL3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # GTDB Precurate

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

`gtdb_precurate` is an internally used tool used that provides automatic pre-curation of GTDB trees.

## Installation

gtdb_precurate is available on PyPI and can be installed with pip:

```bash
pip install gtdb_precurate
```

## Usage

After a successful install, the `gtdb_precurate` command should be available.

The following positional arguments are required:

* `metadata` - This is the path to the metadata file, it should contain a header as the first line.
    The only requirement is that it has the following columns: `formatted_accession` and `ncbi_wgs_formatted`.
* `red_dict` - This is the path to the RED dictionary output by PhyloRank.
* `red_decorated_tree` - This is the path to the scaled RED decorated output by PhyloRank.
* `out_directory` - This is the path to the directory where the output files will be written.

The following optional arguments are available:

* `--min-bootstrap` - This is the minimum bootstrap value to consider a node to be supported. Default: 95.0.
* `--debug` - This enables debug logging. Default: False.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Ecogenomics/gtdb_precurate",
    "name": "gtdb-precurate",
    "maintainer": "Aaron Mussig",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "aaronmussig@gmail.com",
    "keywords": "",
    "author": "Aaron Mussig",
    "author_email": "aaronmussig@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/ca/7c/db3beb7f30bc08c44cdca86cff2cdb41693b4f48c6ca0a10eb0072e209a7/gtdb_precurate-1.0.2.tar.gz",
    "platform": null,
    "description": "# GTDB Precurate\n\n[![PyPI](https://img.shields.io/pypi/v/gtdb_precurate.svg)](https://pypi.python.org/pypi/gtdb_precurate)\n\n`gtdb_precurate` is an internally used tool used that provides automatic pre-curation of GTDB trees.\n\n## Installation\n\ngtdb_precurate is available on PyPI and can be installed with pip:\n\n```bash\npip install gtdb_precurate\n```\n\n## Usage\n\nAfter a successful install, the `gtdb_precurate` command should be available.\n\nThe following positional arguments are required:\n\n* `metadata` - This is the path to the metadata file, it should contain a header as the first line.\n    The only requirement is that it has the following columns: `formatted_accession` and `ncbi_wgs_formatted`.\n* `red_dict` - This is the path to the RED dictionary output by PhyloRank.\n* `red_decorated_tree` - This is the path to the scaled RED decorated output by PhyloRank.\n* `out_directory` - This is the path to the directory where the output files will be written.\n\nThe following optional arguments are available:\n\n* `--min-bootstrap` - This is the minimum bootstrap value to consider a node to be supported. Default: 95.0.\n* `--debug` - This enables debug logging. Default: False.\n\n",
    "bugtrack_url": null,
    "license": "GPL3",
    "summary": "Automatic pre-curation of GTDB trees.",
    "version": "1.0.2",
    "project_urls": {
        "Homepage": "https://github.com/Ecogenomics/gtdb_precurate"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ca7cdb3beb7f30bc08c44cdca86cff2cdb41693b4f48c6ca0a10eb0072e209a7",
                "md5": "74e4ed6f8a33251826576f77f17072dc",
                "sha256": "c4ef1521af833c7b150e1d1adc559c2450792a1d3c8efed2b240b2964f712b40"
            },
            "downloads": -1,
            "filename": "gtdb_precurate-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "74e4ed6f8a33251826576f77f17072dc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 21638,
            "upload_time": "2023-12-12T23:50:58",
            "upload_time_iso_8601": "2023-12-12T23:50:58.095109Z",
            "url": "https://files.pythonhosted.org/packages/ca/7c/db3beb7f30bc08c44cdca86cff2cdb41693b4f48c6ca0a10eb0072e209a7/gtdb_precurate-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-12 23:50:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Ecogenomics",
    "github_project": "gtdb_precurate",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "gtdb-precurate"
}
        
Elapsed time: 0.14757s