Skip to main content

Geneset Network Analysis

Project description

# PyGNA: a Python framework for geneset network analysis

![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/stracquadaniolab/pygna?style=flat-square) [![Anaconda-Server Badge](https://anaconda.org/stracquadaniolab/pygna/badges/version.svg)](https://anaconda.org/stracquadaniolab/pygna) ![Build](https://github.com/stracquadaniolab/pygna/workflows/Build/badge.svg) ![Release](https://github.com/stracquadaniolab/pygna/workflows/Release/badge.svg)

PyGNA is a framework for statistical network analysis of high-throughput experiments. It can be used both as a standalone command line application or it can be used as API to develop custom analyses.

For an overview of PyGNA functionalities check the infographic below or dive into our [Getting started](#getting-started) tour.

![Infographic](docs/pygna_infographic-01.png)

## Installation

The easiest and fastest way to install pygna using conda:

$ conda install -c stracquadaniolab -c bioconda -c conda-forge pygna

Alternatively you can install it through pip:

$ pip install pygna

We also provide a docker image installation with the latest version of PyGNA. It can be easily executed from the command line from DockerHub:

$ docker run stracquadaniolab/pygna/pygna:latest

or GitHub Packages:

$ docker run docker.pkg.github.com/stracquadaniolab/pygna/pygna:latest

which will show the PyGNA command line help.

## Getting started

A typical pygna analysis consists of 3 steps:

  1. Generate the RWR and SP matrices for the network you are using ( once they are generated, you won’t need to repeat the same step again)

  2. Make sure that the input genesets are in the right format. If a network uses entrez ID, and your file is in HUGO symbols, use the pygna utility for the name conversion.

  3. Run the analysis you are interested into.

  4. Once you have the output tables, you can choose to visualize one or more plots.

Otherwise you can check our [snakemake workflow](https://github.com/stracquadaniolab/workflow-pygna) for the full geneset analysis; our workflow contains sample data that you can use to familiarize with our software.

The examples below show some basic analysis that can be carried out with pygna.

### Example 1: Running pygna GNT analysis

Running pygna on this input as follows:

$ cd ./your-path/min-working-example/

$ pygna build-rwr-diffusion barabasi.interactome.tsv –output-file interactome_RWR.hdf5

$ pygna test-topology-rwr barabasi.interactome.tsv disgenet_cancer_groups_subset.gmt interactome_RWR.hdf5 table_topology_rwr.csv –number-of-permutations 1000 –cores 4

$ pygna paint-datasets-stats table_topology_rwr.csv barplot_rwr.pdf

You can look at the plot of the results in the barplot_rwr.pdf file, and the corresponding table in table_topology_rwr.csv.

### Example 2: Running pygna GNA analysis

$ cd ./your-path/min-working-example/

skip this step if the matrix is already computed

$ pygna build-RWR-diffusion barabasi.interactome.tsv –output-file interactome_RWR.hdf5

The association analysis is run N x M times (N number of genesets, M number of pathways), we use only 50 permutations in this example to avoid long computations; however, the recommended value is 1000.

$ pygna test-association-rwr barabasi.interactome.tsv disgenet_cancer_groups_subset.gmt interactome_RWR.hdf5 table_association_rwr.csv -B disgenet_cancer_groups_subset.gmt –keep –number-of-permutations 100 –cores 4

If you don’t include the –results-figure flag at the comparison step, plot the matrix as follows

$ pygna paint-comparison-matrix table_association_rwr.csv heatmap_association_rwr.png –rwr –annotate

The -k flag, keeps the -B geneset and permutes only on the set A.

If setname B is not passed, the analysis is run between each couple of setnames in the geneset.

$ pygna test-association-rwr barabasi.interactome.tsv disgenet_cancer_groups_subset.gmt interactome_RWR.hdf5 table_within_comparison_rwr.csv –number-of-permutations 100 –cores 4

$ pygna paint-comparison-matrix table_within_comparison_rwr.csv heatmap_within_comparison_rwr.png –rwr –single-geneset

You can look at the plot of the results in the heatmap_within_comparison_rwr.png file, and the corresponding table in table_within_comparison_rwr.csv.

## Documentation

The official documentation for pygna can be found on [readthedocs](https://pygna.readthedocs.io/).

## Authors

## Citation

V. Fanfani, F. Cassano, and G. Stracquadanio, “PyGNA: a unified framework for geneset network analysis,” BMC Bioinformatics, vol. 21, no. 1, 2020. DOI: https://doi.org/10.1186/s12859-020-03801-1

` @article{Fanfani2020, author = {Fanfani, Viola and Cassano, Fabio and Stracquadanio, Giovanni}, doi = {10.1186/s12859-020-03801-1}, issn = {14712105}, journal = {BMC Bioinformatics}, number = {1}, pmid = {33092528}, title = {{PyGNA: a unified framework for geneset network analysis}}, volume = {21}, year = {2020} } `

## Issues

Please post an issue to report a bug or request new features.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pygna-3.3.1.tar.gz (49.1 kB view details)

Uploaded Source

Built Distribution

pygna-3.3.1-py3-none-any.whl (56.2 kB view details)

Uploaded Python 3

File details

Details for the file pygna-3.3.1.tar.gz.

File metadata

  • Download URL: pygna-3.3.1.tar.gz
  • Upload date:
  • Size: 49.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for pygna-3.3.1.tar.gz
Algorithm Hash digest
SHA256 24eddb342757619b4f587587194aa7b2ca88eb544e9c733f5f46ac15339f3421
MD5 0853c47a9a4bbb2fe54e85c54abe47d3
BLAKE2b-256 826356e835cd86a4070e90a7d5d6e59bda2eec44cf36393958a2722b685790cb

See more details on using hashes here.

File details

Details for the file pygna-3.3.1-py3-none-any.whl.

File metadata

  • Download URL: pygna-3.3.1-py3-none-any.whl
  • Upload date:
  • Size: 56.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for pygna-3.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6df1248b210e8ba136848f65410c36168d81831f27bd43a3736defbe7cfeab1e
MD5 73ae1191b80454c1019450028d6ad96f
BLAKE2b-256 d5acac23ed8facc52a29cff475d40b3e2ea58beedd66b10703fd4d4f2a1a5eec

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page