toytree


Nametoytree JSON
Version 3.0.4 PyPI version JSON
download
home_pagehttps://eaton-lab.org/toytree
Summarytree manipulation, plotting, and evolutionary analysis library
upload_time2024-07-22 16:15:32
maintainerNone
docs_urlNone
authorDeren Eaton
requires_python>=3.7
licenseGPL
keywords phylogeny tree network plotting toyplot svg html genealogy coalescent
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Toytree
==========

Tree plotting with **Toytree** in Python
----------------------------------------
Welcome to toytree, a minimalist tree manipulation and plotting library 
for use inside jupyter notebooks. Toytree combines a popular tree data 
structure based on the [ete3](http://etetoolkit.org/docs/latest/tutorial/tutorial_trees.html) library with modern plotting tools based on the [toyplot](http://toyplot.rtfd.io/) 
plotting library. The goal of toytree is to provide a light-weight Python equivalent to commonly used tree manipulation and plotting libraries in R, and in doing so, to promote further development of phylogenetic methods in Python. Toytree generates rich interactive figures (SVG+HTML+JS) that can be embedded in jupyter-notebooks or webpages, or rendered in SVG, PDF, or PNG for publications. 


Current release info
--------------------
| Name | Downloads | Version | Platforms |
| --- | --- | --- | --- |
| [![Conda Recipe](https://img.shields.io/badge/recipe-toytree-green.svg)](https://anaconda.org/conda-forge/toytree) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/toytree.svg)](https://anaconda.org/conda-forge/toytree) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/toytree.svg)](https://anaconda.org/conda-forge/toytree) | [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/toytree.svg)](https://anaconda.org/conda-forge/toytree) |

Installing toytree
-------------------
Toytree can be installed using conda or pip (conda preferred):
```
conda install toytree -c conda-forge
```
It is possible to list all of the versions of `toytree` available on your platform with:
```
conda search toytree --channel conda-forge
```

Documentation
-------------
See the [full documentation](http://eaton-lab.org/toytree) to learn more about plotting options, analysis methods, and other features of toytree. You can try out toytree in the cloud before installing by visiting the [toytree binder](http://mybinder.org/repo/eaton-lab/toytree).


Example code
------------

```python
# import toyplot and load a newick file from a public URL
import toytree
tre = toytree.tree("https://eaton-lab.org/data/Cyathophora.tre")

# root the tree using a wildcard string matching and draw a tree figure.
rtre = tre.root('~prz')
rtre.draw(width=400, tip_labels_align=True);

# or chain a few functions together
tre.root('~prz').drop_tips("~tham").ladderize().draw();

# extensive styling options are available
rtre.draw(
    tip_labels_colors='pink',
    node_labels='support',
    node_sizes=15,
    node_colors="cyan",
    edge_style={
        "stroke": "darkgrey", 
        "stroke-width": 3,
    },
)
```

Example plots
------------

![./manuscript/ToyTree-figure.svg](./manuscripts/toytree-1.0/ToyTree-figure.svg)

            

Raw data

            {
    "_id": null,
    "home_page": "https://eaton-lab.org/toytree",
    "name": "toytree",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "phylogeny, tree, network, plotting, toyplot, SVG, HTML, Genealogy, Coalescent",
    "author": "Deren Eaton",
    "author_email": "de2356@columbia.edu",
    "download_url": "https://files.pythonhosted.org/packages/93/c1/3dc83a4dc041d3558c15c3e3fa44f5d57343bef0d27515d5726b0fdb326f/toytree-3.0.4.tar.gz",
    "platform": null,
    "description": "Toytree\n==========\n\nTree plotting with **Toytree** in Python\n----------------------------------------\nWelcome to toytree, a minimalist tree manipulation and plotting library \nfor use inside jupyter notebooks. Toytree combines a popular tree data \nstructure based on the [ete3](http://etetoolkit.org/docs/latest/tutorial/tutorial_trees.html) library with modern plotting tools based on the [toyplot](http://toyplot.rtfd.io/) \nplotting library. The goal of toytree is to provide a light-weight Python equivalent to commonly used tree manipulation and plotting libraries in R, and in doing so, to promote further development of phylogenetic methods in Python. Toytree generates rich interactive figures (SVG+HTML+JS) that can be embedded in jupyter-notebooks or webpages, or rendered in SVG, PDF, or PNG for publications. \n\n\nCurrent release info\n--------------------\n| Name | Downloads | Version | Platforms |\n| --- | --- | --- | --- |\n| [![Conda Recipe](https://img.shields.io/badge/recipe-toytree-green.svg)](https://anaconda.org/conda-forge/toytree) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/toytree.svg)](https://anaconda.org/conda-forge/toytree) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/toytree.svg)](https://anaconda.org/conda-forge/toytree) | [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/toytree.svg)](https://anaconda.org/conda-forge/toytree) |\n\nInstalling toytree\n-------------------\nToytree can be installed using conda or pip (conda preferred):\n```\nconda install toytree -c conda-forge\n```\nIt is possible to list all of the versions of `toytree` available on your platform with:\n```\nconda search toytree --channel conda-forge\n```\n\nDocumentation\n-------------\nSee the [full documentation](http://eaton-lab.org/toytree) to learn more about plotting options, analysis methods, and other features of toytree. You can try out toytree in the cloud before installing by visiting the [toytree binder](http://mybinder.org/repo/eaton-lab/toytree).\n\n\nExample code\n------------\n\n```python\n# import toyplot and load a newick file from a public URL\nimport toytree\ntre = toytree.tree(\"https://eaton-lab.org/data/Cyathophora.tre\")\n\n# root the tree using a wildcard string matching and draw a tree figure.\nrtre = tre.root('~prz')\nrtre.draw(width=400, tip_labels_align=True);\n\n# or chain a few functions together\ntre.root('~prz').drop_tips(\"~tham\").ladderize().draw();\n\n# extensive styling options are available\nrtre.draw(\n    tip_labels_colors='pink',\n    node_labels='support',\n    node_sizes=15,\n    node_colors=\"cyan\",\n    edge_style={\n        \"stroke\": \"darkgrey\", \n        \"stroke-width\": 3,\n    },\n)\n```\n\nExample plots\n------------\n\n![./manuscript/ToyTree-figure.svg](./manuscripts/toytree-1.0/ToyTree-figure.svg)\n",
    "bugtrack_url": null,
    "license": "GPL",
    "summary": "tree manipulation, plotting, and evolutionary analysis library",
    "version": "3.0.4",
    "project_urls": {
        "Homepage": "https://eaton-lab.org/toytree"
    },
    "split_keywords": [
        "phylogeny",
        " tree",
        " network",
        " plotting",
        " toyplot",
        " svg",
        " html",
        " genealogy",
        " coalescent"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fc7d71d1d7d251e611a073450eebb81cac44c9a7cbb02873ee557aeb0a60ce8a",
                "md5": "842cdfdcf4ed69138f7c6fd86e4222ba",
                "sha256": "dc777c55fb5c58d62105bc624ac5de8ee1750d6013b99251eddf5ad9152c4e59"
            },
            "downloads": -1,
            "filename": "toytree-3.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "842cdfdcf4ed69138f7c6fd86e4222ba",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 380700,
            "upload_time": "2024-07-22T16:15:31",
            "upload_time_iso_8601": "2024-07-22T16:15:31.355520Z",
            "url": "https://files.pythonhosted.org/packages/fc/7d/71d1d7d251e611a073450eebb81cac44c9a7cbb02873ee557aeb0a60ce8a/toytree-3.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "93c13dc83a4dc041d3558c15c3e3fa44f5d57343bef0d27515d5726b0fdb326f",
                "md5": "f3503fb47ff73a1d8ed4457bee128a8e",
                "sha256": "3593f5f13a28bd00c0e5e2a27f96152101a7b7f258af79564e294855d3ac3639"
            },
            "downloads": -1,
            "filename": "toytree-3.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "f3503fb47ff73a1d8ed4457bee128a8e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 304368,
            "upload_time": "2024-07-22T16:15:32",
            "upload_time_iso_8601": "2024-07-22T16:15:32.825471Z",
            "url": "https://files.pythonhosted.org/packages/93/c1/3dc83a4dc041d3558c15c3e3fa44f5d57343bef0d27515d5726b0fdb326f/toytree-3.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-22 16:15:32",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "toytree"
}
        
Elapsed time: 0.58037s