tskit-arg-visualizer


Nametskit-arg-visualizer JSON
Version 0.0.3 PyPI version JSON
download
home_pageNone
SummaryInteractive visualization method for ancestral recombination graphs
upload_time2025-01-21 17:10:45
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseNone
keywords population genetics tree sequence ancestral recombination graph visualization d3.js
VCS
bugtrack_url
requirements pandas msprime IPython tqdm
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
  <img alt="ARG Visualizer Example" src="https://raw.githubusercontent.com/kitchensjn/tskit_arg_visualizer/master/images/tskit_arg_visualizer.png" width="500">
</p>

A method for drawing ancestral recombination graphs from tskit tree sequences in Python using D3.js. ARGs are plotted using a D3's [force layout](https://github.com/d3/d3-force). All nodes have a fixed position on the y-axis set by fy. Sample nodes have a fixed position on the x-axis set by fx; the ordering of the sample nodes comes from the first tree in the tskit tree sequence (this is not always the optimal ordering but is generally a good starting point for plotting). The x positions of other nodes are set by a force simulation where all nodes repel each other countered by a linkage force between connected nodes in the graph.

Users can click and drag the nodes (including the sample) along the x-axis to further clean up the layout of the graph. The simulation does not take into account line crosses, which can often be improved with some fiddling. Once a node has been moved by a user, its position is fixed with regards to the force simulation.

See [tutorial.md](https://github.com/kitchensjn/tskit_arg_visualizer/blob/main/docs/tutorial.md) for a walkthrough of the package.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "tskit-arg-visualizer",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "population genetics, tree sequence, ancestral recombination graph, visualization, D3.js",
    "author": null,
    "author_email": "James Kitchens <kitchensjn@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/8f/4c/edff08ec70e5a4fff3d60dc7a7fffcfb520a2c20985f6a1e546c711107f7/tskit_arg_visualizer-0.0.3.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <img alt=\"ARG Visualizer Example\" src=\"https://raw.githubusercontent.com/kitchensjn/tskit_arg_visualizer/master/images/tskit_arg_visualizer.png\" width=\"500\">\n</p>\n\nA method for drawing ancestral recombination graphs from tskit tree sequences in Python using D3.js. ARGs are plotted using a D3's [force layout](https://github.com/d3/d3-force). All nodes have a fixed position on the y-axis set by fy. Sample nodes have a fixed position on the x-axis set by fx; the ordering of the sample nodes comes from the first tree in the tskit tree sequence (this is not always the optimal ordering but is generally a good starting point for plotting). The x positions of other nodes are set by a force simulation where all nodes repel each other countered by a linkage force between connected nodes in the graph.\n\nUsers can click and drag the nodes (including the sample) along the x-axis to further clean up the layout of the graph. The simulation does not take into account line crosses, which can often be improved with some fiddling. Once a node has been moved by a user, its position is fixed with regards to the force simulation.\n\nSee [tutorial.md](https://github.com/kitchensjn/tskit_arg_visualizer/blob/main/docs/tutorial.md) for a walkthrough of the package.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Interactive visualization method for ancestral recombination graphs",
    "version": "0.0.3",
    "project_urls": {
        "Bug Tracker": "https://github.com/kitchensjn/tskit_arg_visualizer/issues",
        "Changelog": "https://github.com/kitchensjn/tskit_arg_visualizer/blob/main/CHANGELOG.rst",
        "Homepage": "https://github.com/kitchensjn/tskit_arg_visualizer"
    },
    "split_keywords": [
        "population genetics",
        " tree sequence",
        " ancestral recombination graph",
        " visualization",
        " d3.js"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6bb791f246a393de38f06b81ea76be4ad1263acf4d288c173315a87597bb24ce",
                "md5": "92831f293d80bab4fbbfafa8f1e80f4f",
                "sha256": "404dec1e0245c788773ee6e56178fc1fc60562c0b4eef30e8984194602af85ef"
            },
            "downloads": -1,
            "filename": "tskit_arg_visualizer-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "92831f293d80bab4fbbfafa8f1e80f4f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 29255,
            "upload_time": "2025-01-21T17:10:43",
            "upload_time_iso_8601": "2025-01-21T17:10:43.769904Z",
            "url": "https://files.pythonhosted.org/packages/6b/b7/91f246a393de38f06b81ea76be4ad1263acf4d288c173315a87597bb24ce/tskit_arg_visualizer-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8f4cedff08ec70e5a4fff3d60dc7a7fffcfb520a2c20985f6a1e546c711107f7",
                "md5": "135eaf6a696dcba24c18ecca6a2be342",
                "sha256": "0423c48b0c730ac0acd319c7e8f50601f454b3615442f5769185922e2b8ae999"
            },
            "downloads": -1,
            "filename": "tskit_arg_visualizer-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "135eaf6a696dcba24c18ecca6a2be342",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 262968,
            "upload_time": "2025-01-21T17:10:45",
            "upload_time_iso_8601": "2025-01-21T17:10:45.114674Z",
            "url": "https://files.pythonhosted.org/packages/8f/4c/edff08ec70e5a4fff3d60dc7a7fffcfb520a2c20985f6a1e546c711107f7/tskit_arg_visualizer-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-21 17:10:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kitchensjn",
    "github_project": "tskit_arg_visualizer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "pandas",
            "specs": []
        },
        {
            "name": "msprime",
            "specs": []
        },
        {
            "name": "IPython",
            "specs": []
        },
        {
            "name": "tqdm",
            "specs": []
        }
    ],
    "lcname": "tskit-arg-visualizer"
}
        
Elapsed time: 0.38396s