pycmplot 0.1.0__py3-none-any.whl

pycmplot-0.1.0.dist-info/METADATA

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: pycmplot
+Version: 0.1.0
+Summary: Multi-track circular and linear Manhattan plot generation for GWAS summary statistics
+Author: Kevin Esoh
+Author-email: Kevin Esoh <kesohku1@jhmi.edu>
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas>=1.5
+Requires-Dist: numpy>=1.23
+Requires-Dist: matplotlib>=3.6
+Requires-Dist: pillow>=9.0
+Requires-Dist: pycirclize>=0.6
+Requires-Dist: natsort>=8.0
+Requires-Dist: adjustText>=0.8
+Requires-Dist: pyliftover>=0.4
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# pycmplot
+
+Multi-track **circular** and **linear** Manhattan plot generation for GWAS summary statistics.
+
+```
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
+|  PACKAGE FOR CIRCULAR AND LINEAR MANHATTAN PLOTTING  |
+|                    Kevin Esoh, 2026                  |
+|                    kesohku1@jh.edu                   |
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
+```
+
+---
+
+## Installation
+
+### From PyPI
+```bash
+pip install pycmplot
+```
+
+
+### From source code
+```bash
+wget <url>
+
+tar zxvf ...
+
+cd pycmplot-xxx
+
+pip install -e .
+```
+
+
+### From GitHub
+```bash
+git clone https://github.com/esohkevin/pycmplot.git
+
+cd pycmplot
+
+pip install -e .
+
+# or
+
+pip install -e . --break-system-packages
+```
+
+
+### Use python virtual environment if local installation is not possible
+```bash
+python -m venv ~/bin/pycmplot
+
+source ~/bin/pycmplot/bin/activate
+
+pip install --upgrade pip setuptools wheel
+
+# then follow any of the installation steps above
+```
+
+
+# Test the installation
+```bash
+pycmplot -h
+```
+
+### Dependencies
+
+| Package | Purpose |
+|---------|---------|
+| pandas, numpy | Data loading & statistics |
+| matplotlib | Plotting backend |
+| pycirclize | Circular (Circos-style) tracks |
+| natsort | Natural chromosome sorting |
+| adjustText | Label collision avoidance |
+| pyliftover | hg19 to hg38 coordinate conversion |
+| Pillow | Image utilities |
+
+---
+
+
+## Command-line usage
+
+### Linear Manhattan (default)
+
+```bash
+pycmplot \
+  --sum_stats HbF.tsv.gz,MCV.txt.gz,MCH.tsv.gz \
+  --labels HbF,MCV,MCH \
+  --logp \
+  --signif_line \
+  --highlight \
+  --annotate GENE \
+  --output_dir ./results \
+  --output_format png \
+  --dpi 300
+```
+
+### Circular Manhattan
+
+```bash
+pycmplot \
+  --sum_stats HbF.tsv.gz,MCV.tsv.gz \
+  --labels HbF,MCV \
+  --mode cm \
+  --logp \
+  --signif_threshold \
+  --plot_title "RBC Traits" \
+  --output_dir ./results
+```
+
+### Key options
+
+| Flag | Description | Default |
+|------|-------------|---------|
+| `-s, --sum_stats` | Comma-separated sumstats files | **required** |
+| `-l, --labels` | Comma-separated track labels | **required** |
+| `-m, --mode` | `lm` linear or `cm` circular | `lm` |
+| `-qq, --qq_plot` | Also generate a QQ-plot | off (coming soon...) |
+| `--logp` | Plot -log10(p) | off |
+| `-sig, --signif_threshold` | Genome-wide significance threshold | off (auto 0.05/N) |
+| `-sigl, --signif_line` | Value for genome-wide significance line if different from `-sig` | `-sig` |
+| `-sug, --suggest_threshold` | Suggestive significance line | off |
+| `-hl, --highlight` | Highlight significant loci | off |
+| `-a, --annotate` | Annotate with `SNP` or `GENE` | `SNP` |
+| `-tp, --trim_pval` | Trim variants above this p-value for speed | off |
+| `-st, --sort_track` | Sort tracks by `label` or `chrom_len` | input order |
+| `-od, --output_dir` | Output directory | `.` |
+| `-of, --output_format` | Output format (`png`, `pdf`, `svg`, `jpg`) | `png` |
+
+Run `pycmplot -h` for the full option list.
+
+---
+
+## Python API
+
+```python
+from pycmplot import plot_linear
+import pandas as pd
+
+df1 = pd.read_csv("HbF.tsv.gz", sep="\t")
+df2 = pd.read_csv("MCV.tsv.gz", sep="\t")
+
+plot_linear(
+    tracks=[df1, df2],
+    track_labels=["HbF", "MCV"],
+    chr_col="CHR",
+    pos_col="POS",
+    p_col="P",
+    logp=True,
+    highlight=True,
+    plot_title="results/HbF_MCV.png",
+    figsize=(15, 8),
+)
+```
+
+---
+
+_Under development_

pycmplot-0.1.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+pycmplot/__init__.py,sha256=YPiGBRDmYozsSL37QnOwcBPKIYrgb-P9FmTxMhtherU,1140
+pycmplot/_core.py,sha256=MkAOXdH0AL0zU6BHASnu3MKhf2lRAMRYXnMoPlaVJU8,16257
+pycmplot/annotation.py,sha256=ixoLOKG_0uTdhZ4FojnBaqtax2bBKkAwm6mRHh25Wws,11673
+pycmplot/cli.py,sha256=mAKElLmf2TTUOO4XuHUvnvJaRMel3D6JftcwfUOC4-U,8272
+pycmplot/constants.py,sha256=By9LgzMZoseD-ungU_bWYj5HBjHqsLy-eXjPx043YIA,2479
+pycmplot/io.py,sha256=xgNo2AGWUHxfVe0bzd88QG8gdUfT0ROPXj_nUr-9Hvg,10998
+pycmplot/liftover.py,sha256=N4gch5vujBSzotltZxnHFSCTyhpx7RKhtQZV8p7B-HI,3484
+pycmplot/resources.py,sha256=_aMYAYp0je3C4hV92D1DLeDB7z7vwhOvMxqlFMPNU1k,3796
+pycmplot/stats.py,sha256=zuQRaZB7MS9Tm6STclKJOOH4eok7QuBHv2KMDy2gXQM,2737
+pycmplot/data/Homo_sapiens.GRCh37.geneinfo.tsv.gz,sha256=kLldtgT5-k4ZzU5jN--woFZEuOaWe9pQ4g4hhB3sdQI,840666
+pycmplot/data/Homo_sapiens.GRCh38.geneinfo.tsv.gz,sha256=cRAuNxifZi12yOxNKrVt0uTS52HwDDFzV_1N4E2Qwuw,626249
+pycmplot/data/hg19ToHg38.over.chain,sha256=oHPYkUIztVQtKXYauOxLOBUFKxOWSRnBKh77LjEfvzk,606773
+pycmplot/plotting/circular.py,sha256=xfvcetniwxbze1DatLndwgIeMd94co22vqsl1__8rMY,8245
+pycmplot/plotting/linear.py,sha256=1kOWXeLNUXKUDPse0gwoOBIifljeVeRjo6bbHB6PFTA,11690
+pycmplot-0.1.0.dist-info/licenses/LICENSE,sha256=5SMaKQ5Xs1D8Uhw5wtKL3jtVFbUilhD0Bp4u8hQNbO8,1067
+pycmplot-0.1.0.dist-info/METADATA,sha256=IHYPHOqYSrJMph0O6hnbBDhm8-YCQviNjDUnxlLtAgo,4077
+pycmplot-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+pycmplot-0.1.0.dist-info/entry_points.txt,sha256=cE8IAltA_Q-QQuWQ5DE3Lv-9ktYQ_jyWaD6I97QbeyU,49
+pycmplot-0.1.0.dist-info/top_level.txt,sha256=VGwUCEinUFAwhMXKJfE1E58MhSRdvO6PRUonY6kPbV0,9
+pycmplot-0.1.0.dist-info/RECORD,,

pycmplot-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pycmplot-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pycmplot = pycmplot._core:main

pycmplot-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kevin Esoh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pycmplot-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pycmplot