homologyviz


Namehomologyviz JSON
Version 0.0.21 PyPI version JSON
download
home_pageNone
SummaryMake graphical representations of BLASTn alignments
upload_time2024-11-27 19:03:57
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseBSD 3-Clause License
keywords dna alignments blastn graphical blastn alignments easyfig
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
   <img src="https://raw.githubusercontent.com/ivanmugu/homologyviz/refs/heads/main/src/homologyviz/images/logo.png" alt="HomologyViz" width="450">
</p>

<div align="center">

![PyPI Version](https://img.shields.io/pypi/v/homologyviz)
![GitHub License](https://img.shields.io/github/license/ivanmugu/homologyviz)
![Python](https://img.shields.io/badge/python-3.11-blue.svg)

</div>

---

# Make a graphical representation of BLASTn alignments
Homology Visualization (HomologyViz) uses GenBank files (.gb) to align the sequences and plot the genes. HomologyViz uses the information from the `CDS` features section to plot the genes. To customize the colors for plotting genes, you can add a `Color` tag in the `CDS` features with a color in hexadecimal. For example, add the tag `/Color="#00ff00"` to show a green gene. Or, you can edit the colors interactively in the plot.

HomologyViz is an easy-to-use option for people with little coding knowledge. The program uses Dash for an interactive and web-friendly experience. HomologyViz is a flexible app that allows you to export your graph in different formats and sizes for publication quality.

## Requirements

- [blastn](https://www.ncbi.nlm.nih.gov/books/NBK569861/) must be installed
  locally and in the path

HomologyViz has been tested in Chrome using macOS.

## Installation

First, create a virtual environment with `conda` or `venv`. Then, install
homologyviz using pip as follows:

```bash
pip install homologyviz
```

## Usage

To run the app type:

```bash
homologyviz
```

Output:
<p align="center">
   <img src="https://raw.githubusercontent.com/ivanmugu/homologyviz/refs/heads/main/src/homologyviz/images/HomologyViz_app.png" alt="HomologyViz" width="600">
</p>


## Credits

Inspired by easyfig: Sullivan et al (2011) Bioinformatics 27(7):1009-1010

## License

BSD 3-Clause License

## Notes

I am developing HomologyViz in my free time, so if you find a bug, it may take me some time to fix it. However, I will fix the problems as soon as possible. Also, if you have any suggestions, let me know, and I will try to implement them.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "homologyviz",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "Ivan Munoz-Gutierrez <ivan.munoz.gutierrez@gmail.com>",
    "keywords": "DNA alignments, BLASTn, Graphical BLASTn alignments, easyfig",
    "author": null,
    "author_email": "Ivan Munoz-Gutierrez <ivan.munoz.gutierrez@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/81/ae/18131ed38937ab20471b0faf42bd916e68479b95bfccda66588b8823f418/homologyviz-0.0.21.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n   <img src=\"https://raw.githubusercontent.com/ivanmugu/homologyviz/refs/heads/main/src/homologyviz/images/logo.png\" alt=\"HomologyViz\" width=\"450\">\n</p>\n\n<div align=\"center\">\n\n![PyPI Version](https://img.shields.io/pypi/v/homologyviz)\n![GitHub License](https://img.shields.io/github/license/ivanmugu/homologyviz)\n![Python](https://img.shields.io/badge/python-3.11-blue.svg)\n\n</div>\n\n---\n\n# Make a graphical representation of BLASTn alignments\nHomology Visualization (HomologyViz) uses GenBank files (.gb) to align the sequences and plot the genes. HomologyViz uses the information from the `CDS` features section to plot the genes. To customize the colors for plotting genes, you can add a `Color` tag in the `CDS` features with a color in hexadecimal. For example, add the tag `/Color=\"#00ff00\"` to show a green gene. Or, you can edit the colors interactively in the plot.\n\nHomologyViz is an easy-to-use option for people with little coding knowledge. The program uses Dash for an interactive and web-friendly experience. HomologyViz is a flexible app that allows you to export your graph in different formats and sizes for publication quality.\n\n## Requirements\n\n- [blastn](https://www.ncbi.nlm.nih.gov/books/NBK569861/) must be installed\n  locally and in the path\n\nHomologyViz has been tested in Chrome using macOS.\n\n## Installation\n\nFirst, create a virtual environment with `conda` or `venv`. Then, install\nhomologyviz using pip as follows:\n\n```bash\npip install homologyviz\n```\n\n## Usage\n\nTo run the app type:\n\n```bash\nhomologyviz\n```\n\nOutput:\n<p align=\"center\">\n   <img src=\"https://raw.githubusercontent.com/ivanmugu/homologyviz/refs/heads/main/src/homologyviz/images/HomologyViz_app.png\" alt=\"HomologyViz\" width=\"600\">\n</p>\n\n\n## Credits\n\nInspired by easyfig: Sullivan et al (2011) Bioinformatics 27(7):1009-1010\n\n## License\n\nBSD 3-Clause License\n\n## Notes\n\nI am developing HomologyViz in my free time, so if you find a bug, it may take me some time to fix it. However, I will fix the problems as soon as possible. Also, if you have any suggestions, let me know, and I will try to implement them.\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License",
    "summary": "Make graphical representations of BLASTn alignments",
    "version": "0.0.21",
    "project_urls": {
        "Repository": "https://github.com/ivanmugu/msplotly.git"
    },
    "split_keywords": [
        "dna alignments",
        " blastn",
        " graphical blastn alignments",
        " easyfig"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7e36c18a696a35ad17147b4749f38af03d62c282e3984439438773084e6f28fc",
                "md5": "9774c1489cf370a2a152936ad9814acb",
                "sha256": "015f53282cb3055cccace7e037c9228c2baf8df5347223791a70211686e728c0"
            },
            "downloads": -1,
            "filename": "homologyviz-0.0.21-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9774c1489cf370a2a152936ad9814acb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 254616,
            "upload_time": "2024-11-27T19:03:56",
            "upload_time_iso_8601": "2024-11-27T19:03:56.017048Z",
            "url": "https://files.pythonhosted.org/packages/7e/36/c18a696a35ad17147b4749f38af03d62c282e3984439438773084e6f28fc/homologyviz-0.0.21-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "81ae18131ed38937ab20471b0faf42bd916e68479b95bfccda66588b8823f418",
                "md5": "630baf06f3eb6facb49e1c1c56d1bf22",
                "sha256": "aa73c2479fdcae22b8bda4f304314a17da5aad3451ae896e5567752ca7f35b58"
            },
            "downloads": -1,
            "filename": "homologyviz-0.0.21.tar.gz",
            "has_sig": false,
            "md5_digest": "630baf06f3eb6facb49e1c1c56d1bf22",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 254706,
            "upload_time": "2024-11-27T19:03:57",
            "upload_time_iso_8601": "2024-11-27T19:03:57.213038Z",
            "url": "https://files.pythonhosted.org/packages/81/ae/18131ed38937ab20471b0faf42bd916e68479b95bfccda66588b8823f418/homologyviz-0.0.21.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-27 19:03:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ivanmugu",
    "github_project": "msplotly",
    "github_not_found": true,
    "lcname": "homologyviz"
}
        
Elapsed time: 0.38548s