This page describes the application programming interface (API) for PyPGx.
Below is the list of submodules available in the API:
- core : The core submodule is the main suite of tools for PGx research.
- genotype : The genotype submodule is primarily used to make final diplotype calls by interpreting candidate star alleles and/or detected structural variants.
- pipeline : The pipeline submodule is used to provide convenient methods that combine multiple PyPGx actions and automatically handle semantic types.
- plot : The plot submodule is used to plot various kinds of profiles such as read depth, copy number, and allele fraction.
- utils : The utils submodule contains main actions of PyPGx.
For getting help on a specific submodule (e.g. utils):
from pypgx.api import utils
help(utils)pypgx.api.core
pypgx.api.genotype
pypgx.api.pipeline
pypgx.api.plot
pypgx.api.utils