Skip to main content

Geneset Network Analysis

Project description

# PyGNA: a Python framework for geneset network analysis

Current version: 2.0.1-dev

[![Build Status](http://drone.stracquadaniolab.org/api/badges/stracquadaniolab/pygna/status.svg)](http://drone.stracquadaniolab.org/stracquadaniolab/pygna) [![Anaconda-Server Badge](https://anaconda.org/stracquadaniolab/pygna/badges/platforms.svg)](https://anaconda.org/stracquadaniolab/pygna) [![Anaconda-Server Badge](https://anaconda.org/stracquadaniolab/pygna/badges/version.svg)](https://anaconda.org/stracquadaniolab/pygna)

PyGNA is a unified framework for network analysis of high-throughput experiment results. It can be used both as a standalone command line application or it can be included as a package in your own python code.

For an overview of PyGNA functionalities check the infographic below, otherwise dive into the [Getting started](#getting-started) guide.

![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

Please note, that pip will not install non Python requirements.

## 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 –number-of-permutations 50 barabasi.interactome.tsv disgenet_cancer_groups_subset.gmt interactome_RWR.hdf5 ./ example1

$ pygna paint-datasets-stats interactome_table_RW.csv ./ example1

You can look at the plot of the results in the example1_results.pdf file, and the corresponding table in example1_table_RW.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 ./ example2 -B GO_cc_subset.gmt -k –number-of-permutations 50 –show-results

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

$ pygna paint-comparison-RW example2_table_association_rwr.csv ./ comparison_stats

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 ./ example2_full –number-of-permutations 50 –show-results

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

## Documentation

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

## Authors

## Citation

A unified framework for geneset network analysis. Viola Fanfani, Giovanni Stracquadanio. bioRxiv 699926; doi: https://doi.org/10.1101/699926

## Issues

Please post an issue to report a bug or request new features. We are now working on code refactoring and standardising the I/O behaviour.

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-2.0.1.dev0.tar.gz (28.1 kB view details)

Uploaded Source

Built Distribution

pygna-2.0.1.dev0-py3-none-any.whl (33.5 kB view details)

Uploaded Python 3

File details

Details for the file pygna-2.0.1.dev0.tar.gz.

File metadata

  • Download URL: pygna-2.0.1.dev0.tar.gz
  • Upload date:
  • Size: 28.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

File hashes

Hashes for pygna-2.0.1.dev0.tar.gz
Algorithm Hash digest
SHA256 7c81d5cc5a79d21e90378a4c8cbf4acad3fdd47e37caa034db3653a02501429d
MD5 cb156935b61ea3cf02c8fcde54f77b5c
BLAKE2b-256 97323d9eaf81b809f9c14db85de1343c95dcb9fa50495f98f22d0315e91545ea

See more details on using hashes here.

File details

Details for the file pygna-2.0.1.dev0-py3-none-any.whl.

File metadata

  • Download URL: pygna-2.0.1.dev0-py3-none-any.whl
  • Upload date:
  • Size: 33.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

File hashes

Hashes for pygna-2.0.1.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 a7006056d6c27ae2b30cd91f109c442f52c6c0e7eb169ce133691f94366595b6
MD5 cc1d00d7417745ccb8508ef00035a5a2
BLAKE2b-256 a9c9760a0f31ce81e18c126ea9de7076b1c99471f4a751851b7fc1daf2437f32

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