| Name | quyuan JSON |
| Version |
1.1.3
JSON |
| download |
| home_page | |
| Summary | A simple way to visualize features on human and other species chromosome ideograms, folk of jordanlab/tagore |
| upload_time | 2023-05-25 07:22:45 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | |
| keywords |
human
chromosome
ideogram
visualization
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# quyuan
`quyuan` is a folk of [`tagore`](https://github.com/jordanlab/tagore) with several modifications to make it more suitable for my own use.
## Installation
`quyuan` is a simple Python script with several dependencies.
```console
$ pip install git+https://github.com/tcztzy/quyuan.git
$ quyuan --version
quyuan, version 1.1.2
```
### Requirements
* Python 3.6+
* [CairoSVG](https://cairosvg.org/)
* [Click](https://click.palletsprojects.com/en/7.x/)
* [Colorama](https://pypi.org/project/colorama/)
## Quick start
The demo data consists of [Catalogue of Somatic Mutations in Cancer (COSMIC) Cancer Gene Census](https://www.nature.com/articles/s41568-018-0060-1) genes and 100 randomly simulated mutations. Points represent single nucleotide variants (i.e. variant present in <3 samples); triangles represent single nucleotide polymorphisms (i.e. variants found in many samples); and short lines (single chromosome) represent known INDEL sites.
```console
$ quyuan --input example_ideogram/test.bed --prefix example_ideogram/example -vf
```
## Usage
```
Usage: quyuan [OPTIONS]
quyuan: a utility for illustrating human chromosomes
https://github.com/tcztzy/quyuan
Options:
--version Show the version and exit.
-i, --input <input.bed> Input BED-like file [required]
-p, --prefix [output file prefix]
Output prefix [Default: "out"]
-b, --build [hg37|hg38|irgsp1] Human genome build to use [Default: hg38]
-f, --force Overwrite output files if they exist already
-ofmt, --oformat [png|pdf|ps|svg]
Output format for conversion
-v, --verbose Display verbose output
--help Show this message and exit.
```
The input file is a bed-like format, described below. If an output prefix is not specified, the scripts uses "out" as the default prefix.
Helper scripts for converting RFMix and ADMIXTURE outputs are included in the `scripts/` folder.
A more complete example of a full chromosome painting using an RFMix output can be seen by running:
```bash
rfmix2tagore --chr1 example_ideogram/1KGP-MXL104_chr1.bed \
--chr2 example_ideogram/1KGP-MXL104_chr2.bed \
--out example_ideogram/1KGP-MXL104_tagore.bed
quyuan --input example_ideogram/1KGP-MXL104_tagore.bed \
--prefix example_ideogram/1KGP-MXL104 \
--build hg37 \
--verbose
```
## Input file description
```
#chr start stop feature size color chrCopy
chr1 10000000 20000000 0 1 #FF0000 1
chr2 20000000 30000000 0 1 #FF0000 2
chr2 40000000 50000000 0 0.5 #FF0000 1
```
Each column is explained below:
1. *chr* - The chromosome on which a feature has to be drawn
2. *start* - Start position (in bp) for feature
3. *stop* - Stop position (in bp) for feature
4. *feature* - The shape of the feature to be drawn
* 0 will draw a rectangle
* 1 will draw a circle
* 2 will draw a triangle pointing to the genomic location
* 3 will draw a line at that genomic location
5. *size* - The horizontal size of the feature. Should range between 0 and 1.
6. *color* - Specify the color of the genomic feature with a hex value (#FF0000 for red, etc.)
7. *chrCopy* - Specify the chromosome copy on which the feature should be drawn (1 or 2). To draw the same feature on both chromosomes, you must specify the feature twice
## Etymology
[Qu Yuan](https://en.wikipedia.org/wiki/Qu_Yuan) (屈原) was a Chinese patriot poet and politician living in c.340BC - 278BC.
Raw data
{
"_id": null,
"home_page": "",
"name": "quyuan",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Human,chromosome,ideogram,visualization",
"author": "",
"author_email": "Tang Ziya <tang@stu.njau.edu.cn>, Applied Bioinformatics Laboratory <abil@ihrc.com>",
"download_url": "",
"platform": null,
"description": "# quyuan\n\n`quyuan` is a folk of [`tagore`](https://github.com/jordanlab/tagore) with several modifications to make it more suitable for my own use.\n\n\n\n## Installation\n\n`quyuan` is a simple Python script with several dependencies.\n\n```console\n$ pip install git+https://github.com/tcztzy/quyuan.git\n$ quyuan --version\nquyuan, version 1.1.2\n```\n\n### Requirements\n* Python 3.6+\n* [CairoSVG](https://cairosvg.org/)\n* [Click](https://click.palletsprojects.com/en/7.x/)\n* [Colorama](https://pypi.org/project/colorama/)\n\n## Quick start\n\nThe demo data consists of [Catalogue of Somatic Mutations in Cancer (COSMIC) Cancer Gene Census](https://www.nature.com/articles/s41568-018-0060-1) genes and 100 randomly simulated mutations. Points represent single nucleotide variants (i.e. variant present in <3 samples); triangles represent single nucleotide polymorphisms (i.e. variants found in many samples); and short lines (single chromosome) represent known INDEL sites.\n\n```console\n$ quyuan --input example_ideogram/test.bed --prefix example_ideogram/example -vf\n```\n\n## Usage\n```\nUsage: quyuan [OPTIONS]\n\n quyuan: a utility for illustrating human chromosomes\n https://github.com/tcztzy/quyuan\n\nOptions:\n --version Show the version and exit.\n -i, --input <input.bed> Input BED-like file [required]\n -p, --prefix [output file prefix]\n Output prefix [Default: \"out\"]\n -b, --build [hg37|hg38|irgsp1] Human genome build to use [Default: hg38]\n -f, --force Overwrite output files if they exist already\n -ofmt, --oformat [png|pdf|ps|svg]\n Output format for conversion\n -v, --verbose Display verbose output\n --help Show this message and exit.\n```\nThe input file is a bed-like format, described below. If an output prefix is not specified, the scripts uses \"out\" as the default prefix.\n\nHelper scripts for converting RFMix and ADMIXTURE outputs are included in the `scripts/` folder.\n\nA more complete example of a full chromosome painting using an RFMix output can be seen by running:\n\n```bash\nrfmix2tagore --chr1 example_ideogram/1KGP-MXL104_chr1.bed \\\n\t--chr2 example_ideogram/1KGP-MXL104_chr2.bed \\\n\t--out example_ideogram/1KGP-MXL104_tagore.bed\n\nquyuan --input example_ideogram/1KGP-MXL104_tagore.bed \\\n\t--prefix example_ideogram/1KGP-MXL104 \\\n --build hg37 \\\n --verbose\n\n```\n\n## Input file description\n```\n#chr\tstart\tstop\tfeature\tsize\tcolor\tchrCopy\nchr1\t10000000\t20000000\t0\t1\t#FF0000\t1\nchr2\t20000000\t30000000\t0\t1\t#FF0000\t2\nchr2\t40000000\t50000000\t0\t0.5\t#FF0000\t1\n```\n\nEach column is explained below:\n1. *chr* - The chromosome on which a feature has to be drawn\n2. *start* - Start position (in bp) for feature\n3. *stop* - Stop position (in bp) for feature\n4. *feature* - The shape of the feature to be drawn\n\t* 0 will draw a rectangle\n\t* 1 will draw a circle\n\t* 2 will draw a triangle pointing to the genomic location\n\t* 3 will draw a line at that genomic location\n5. *size* - The horizontal size of the feature. Should range between 0 and 1.\n6. *color* - Specify the color of the genomic feature with a hex value (#FF0000 for red, etc.)\n7. *chrCopy* - Specify the chromosome copy on which the feature should be drawn (1 or 2). To draw the same feature on both chromosomes, you must specify the feature twice\n\n\n## Etymology\n\n[Qu Yuan](https://en.wikipedia.org/wiki/Qu_Yuan) (\u5c48\u539f) was a Chinese patriot poet and politician living in c.340BC - 278BC.\n",
"bugtrack_url": null,
"license": "",
"summary": "A simple way to visualize features on human and other species chromosome ideograms, folk of jordanlab/tagore",
"version": "1.1.3",
"project_urls": {
"homepage": "https://github.com/tcztzy/quyuan"
},
"split_keywords": [
"human",
"chromosome",
"ideogram",
"visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "62c419845da28bbda6a2a78ac4de8adf99fcb2ba2f201e810ae33ba429fe9341",
"md5": "5b9dae38dd989d58535c947ce9f28a6c",
"sha256": "129d6085203b37a9a31cc5bea47041db1aeb4d42f8754751fb2cf807ad1a1720"
},
"downloads": -1,
"filename": "quyuan-1.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5b9dae38dd989d58535c947ce9f28a6c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 26284,
"upload_time": "2023-05-25T07:22:45",
"upload_time_iso_8601": "2023-05-25T07:22:45.179027Z",
"url": "https://files.pythonhosted.org/packages/62/c4/19845da28bbda6a2a78ac4de8adf99fcb2ba2f201e810ae33ba429fe9341/quyuan-1.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-25 07:22:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tcztzy",
"github_project": "quyuan",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "quyuan"
}
