* [tagore](#tagore)
* [Installation](#installation)
* [Requirements](#requirements)
* [Quick start](#quick-start)
* [Usage](#usage)
* [Input file description](#input-file-description)
* [Etymology](#etymology)
# tagore
`tagore` is a simple way to visualize features on human chromosome ideograms as shown in this article: https://www.nature.com/articles/srep12376
`tagore` was designed to allow everyone to create 23andMe style chromosome painting diagrams.
## Installation
`tagore` is a simple Python script that uses the RSVG library and has no other depenendies.
```bash
pip install tagore
tagore --version
# tagore (version 1.1.2)
```
### Requirements
* Python 3.6+
* [RSVG](https://developer.gnome.org/rsvg/stable/)
* [Click](https://click.palletsprojects.com/en/7.x/) (automatically installed if `pip` is used)
## 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.
```bash
tagore --input example_ideogram/test.bed --prefix example_ideogram/example -vf
```
## Usage
```
usage: tagore [-h] [--version] -i <input.bed> [-p [output file prefix]] [-b [hg78/hg38]] [-f] [-v]
tagore: a utility for illustrating human chromosomes https://github.com/jordanlab/tagore
optional arguments:
-h, --help show this help message and exit
--version Print the software version
-i <input.bed>, --input <input.bed> Input BED-like file
-p [output file prefix], --prefix [output file prefix] Output prefix [Default: "out"]
-b [hg78/hg38], --build [hg78/hg38] Human genome build to use [Default: hg38]
-f, --force Overwrite output files if they exist already
-v, --verbose Display verbose output
```
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
tagore --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
[Tagore](https://en.wikipedia.org/wiki/Rabindranath_Tagore) (/tæˈgɔːr/) was a prolific songwriter,
artist, and influential poet of 19th and 20th century India. Notably, Tagore spoke out against
racial prejudice and espoused the princple respect for all people, regardless of ancestry or
ethnic bacground.
Raw data
{
"_id": null,
"home_page": "https://github.com/jordanlab/tagore",
"name": "tagore",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Human,chromosome,ideogram,visualization",
"author": "Applied Bioinformatics Laboratory",
"author_email": "abil@ihrc.com",
"download_url": "https://files.pythonhosted.org/packages/13/8c/22c04804855415dc4676dcde030247021fe4a411a8beaa50758d0e9cfa7a/tagore-1.1.2.tar.gz",
"platform": null,
"description": " * [tagore](#tagore) \n * [Installation](#installation) \n * [Requirements](#requirements) \n * [Quick start](#quick-start) \n * [Usage](#usage) \n * [Input file description](#input-file-description) \n * [Etymology](#etymology) \n\n# tagore\n\n`tagore` is a simple way to visualize features on human chromosome ideograms as shown in this article: https://www.nature.com/articles/srep12376\n\n`tagore` was designed to allow everyone to create 23andMe style chromosome painting diagrams.\n\n\n\n## Installation\n\n`tagore` is a simple Python script that uses the RSVG library and has no other depenendies.\n\n```bash\npip install tagore\ntagore --version\n# tagore (version 1.1.2)\n```\n\n### Requirements\n* Python 3.6+\n* [RSVG](https://developer.gnome.org/rsvg/stable/)\n* [Click](https://click.palletsprojects.com/en/7.x/) (automatically installed if `pip` is used)\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```bash\ntagore --input example_ideogram/test.bed --prefix example_ideogram/example -vf\n```\n\n## Usage\n```\nusage: tagore [-h] [--version] -i <input.bed> [-p [output file prefix]] [-b [hg78/hg38]] [-f] [-v]\n\ntagore: a utility for illustrating human chromosomes https://github.com/jordanlab/tagore\n\noptional arguments:\n -h, --help show this help message and exit\n --version Print the software version\n -i <input.bed>, --input <input.bed> Input BED-like file\n -p [output file prefix], --prefix [output file prefix] Output prefix [Default: \"out\"]\n -b [hg78/hg38], --build [hg78/hg38] Human genome build to use [Default: hg38]\n -f, --force Overwrite output files if they exist already\n -v, --verbose Display verbose output\n\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\ntagore --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[Tagore](https://en.wikipedia.org/wiki/Rabindranath_Tagore) (/t\u00e6\u02c8g\u0254\u02d0r/) was a prolific songwriter,\n artist, and influential poet of 19th and 20th century India. Notably, Tagore spoke out against\n racial prejudice and espoused the princple respect for all people, regardless of ancestry or\n ethnic bacground.\n",
"bugtrack_url": null,
"license": "",
"summary": "A simple way to visualize features on human chromosome ideograms",
"version": "1.1.2",
"split_keywords": [
"human",
"chromosome",
"ideogram",
"visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "428dbed40d62e398943c23b2948a95c6",
"sha256": "7e64edf853655c07bfbaaeb453100a0fbf33c1a9c96ea3ac79dada817e552859"
},
"downloads": -1,
"filename": "tagore-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "428dbed40d62e398943c23b2948a95c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 25345,
"upload_time": "2022-12-23T17:26:44",
"upload_time_iso_8601": "2022-12-23T17:26:44.186931Z",
"url": "https://files.pythonhosted.org/packages/ed/8c/6c7478e6f90c958729806593965ab250ed168a470789596d4a16ffcc45b3/tagore-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "735684939e14f56be7c35e44dcd1b7bf",
"sha256": "9d484ce0ade2e4ef098fb401bc47a8412e7804efa2aca248040fc285893f1568"
},
"downloads": -1,
"filename": "tagore-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "735684939e14f56be7c35e44dcd1b7bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 26712,
"upload_time": "2022-12-23T17:26:45",
"upload_time_iso_8601": "2022-12-23T17:26:45.619758Z",
"url": "https://files.pythonhosted.org/packages/13/8c/22c04804855415dc4676dcde030247021fe4a411a8beaa50758d0e9cfa7a/tagore-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-23 17:26:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jordanlab",
"github_project": "tagore",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tagore"
}
JSON
