sniffles2-plot


Namesniffles2-plot JSON
Version 0.2.1 PyPI version JSON
download
home_pageNone
Summarya visualizer tool for plot generating
upload_time2024-08-18 20:50:18
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Sniffles Plot

## Introduction

The Sniffle Plot is a Python program that generates plots for single and multi-sample VCF files.

Type of plots for single sample VCF file:

1. Variant Frequency Spectrum
2. Genotype Frequency
3. SV Size & Type Distribution
4. Comparison of Length of Variants

Type of plots for multi samples VCF file:
    
1. Variant Frequency Spectrum
2. Upset plot for sample intersection
3. SV sites per genome
4. Variant call all SVs
5. Size distribution
6. Heat map for deletion and insertion intersections



## Quick Start
To install this package you can simply run the following command:
```
$ pip3 install sniffles2-plot
```

For running the program for multiple vcf files located in a sepcific directory:
```
$ python3 -m sniffles2_plot -i <VCF_files_folder>
``` 
     
For running the program for a single vcf file:
```
$ python3 -m sniffles2_plot -i <file_name> -o <output_folder>
```
Sample results of output:

<img src="./pictures/del_ins_type_size.jpg" width="200" height="200">
<img src="./pictures/hetamap.jpg" width="200" height="200">

<img src="./pictures/length_variant.jpg" width="200" height="200">
<img src="./pictures/sample_upset.png" width="200" height="200">



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sniffles2-plot",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/f0/0f/ecc87d85081ca83d3d7ca40047f81f8d5438ae380c2d546dcd6e08cb3c29/sniffles2_plot-0.2.1.tar.gz",
    "platform": null,
    "description": "# Sniffles Plot\n\n## Introduction\n\nThe Sniffle Plot is a Python program that generates plots for single and multi-sample VCF files.\n\nType of plots for single sample VCF file:\n\n1. Variant Frequency Spectrum\n2. Genotype Frequency\n3. SV Size & Type Distribution\n4. Comparison of Length of Variants\n\nType of plots for multi samples VCF file:\n    \n1. Variant Frequency Spectrum\n2. Upset plot for sample intersection\n3. SV sites per genome\n4. Variant call all SVs\n5. Size distribution\n6. Heat map for deletion and insertion intersections\n\n\n\n## Quick Start\nTo install this package you can simply run the following command:\n```\n$ pip3 install sniffles2-plot\n```\n\nFor running the program for multiple vcf files located in a sepcific directory:\n```\n$ python3 -m sniffles2_plot -i <VCF_files_folder>\n``` \n     \nFor running the program for a single vcf file:\n```\n$ python3 -m sniffles2_plot -i <file_name> -o <output_folder>\n```\nSample results of output:\n\n<img src=\"./pictures/del_ins_type_size.jpg\" width=\"200\" height=\"200\">\n<img src=\"./pictures/hetamap.jpg\" width=\"200\" height=\"200\">\n\n<img src=\"./pictures/length_variant.jpg\" width=\"200\" height=\"200\">\n<img src=\"./pictures/sample_upset.png\" width=\"200\" height=\"200\">\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "a visualizer tool for plot generating",
    "version": "0.2.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6050395b52e9627ca2532869475344f77305aa2b52b49d5be89bc0e66f47de44",
                "md5": "1d53445578ef0ab21967c89012da5d4c",
                "sha256": "7b61d7f4bb46e7d9defa45deefb6ce87b9837fed21b5dc47f863eb43be2f1a74"
            },
            "downloads": -1,
            "filename": "sniffles2_plot-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1d53445578ef0ab21967c89012da5d4c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 20712,
            "upload_time": "2024-08-18T20:50:16",
            "upload_time_iso_8601": "2024-08-18T20:50:16.641921Z",
            "url": "https://files.pythonhosted.org/packages/60/50/395b52e9627ca2532869475344f77305aa2b52b49d5be89bc0e66f47de44/sniffles2_plot-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f00fecc87d85081ca83d3d7ca40047f81f8d5438ae380c2d546dcd6e08cb3c29",
                "md5": "649540cad4a1b66c432cfe9363538f1f",
                "sha256": "938a5dda606f4221cec905ecc72542f4fc461e55b8ec9533c62d55fcd2c43fee"
            },
            "downloads": -1,
            "filename": "sniffles2_plot-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "649540cad4a1b66c432cfe9363538f1f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 14373,
            "upload_time": "2024-08-18T20:50:18",
            "upload_time_iso_8601": "2024-08-18T20:50:18.053563Z",
            "url": "https://files.pythonhosted.org/packages/f0/0f/ecc87d85081ca83d3d7ca40047f81f8d5438ae380c2d546dcd6e08cb3c29/sniffles2_plot-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-18 20:50:18",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "sniffles2-plot"
}
        
Elapsed time: 5.41501s