API Reference
This section is auto-generated from NumPy (numpydoc) docstrings in the GWASLab source code using mkdocstrings. Parameter tables use a consistent layout (docstring_section_style: table). See Documentation Style Guide — Docstrings for the canonical format.
Quick start
import gwaslab as gl
mysumstats = gl.Sumstats("sumstats.txt.gz", fmt="plink2")
mysumstats.basic_check()
mysumstats.plot_mqq()
Pages
| Page | Contents |
|---|---|
| Package functions | Top-level gl.* re-exports (non-plot) |
| Reference & utilities | gl.download_ref, gl.get_path, gl.get_power, … |
| I/O helpers | gl.read_ldsc, gl.load_pickle, tabular readers |
| Plotting | Top-level gl.plot_*, gl.compare_effect, gl.scatter — user guides: Lead Overlap, Sankey |
| Sumstats → Core | gl.Sumstats loading, pipelines, harmonization, I/O |
| Sumstats → Fix | fix_id, fix_chr, check_sanity, … |
| Sumstats → Filter | filter_value, filter_region, exclude_hla, … |
| Sumstats → Plot | mysumstats.plot_mqq, plot_region, … |
| Sumstats → Downstream | get_lead, LDSC, clumping, finemapping, PRS |
For tutorials and workflow examples, see Tutorial, QC and Filtering, Harmonization, and Visualization.
Build locally
pip install -e ".[docs]"
pip install zensical
zensical serve # live preview
# or:
zensical build --clean
Generated docs
Parameter lists for plot functions reflect the visualization parameter registry and match help(gl.plot_miami2) / help(mysumstats.plot_region).