Skip to main content

visualizes genes functional enrichment

Project description

apafea

 ______     ______   ______     ______   ______     ______    
/\  __ \   /\  == \ /\  __ \   /\  ___\ /\  ___\   /\  __ \   
\ \  __ \  \ \  _-/ \ \  __ \  \ \  __\ \ \  __\   \ \  __ \  
 \ \_\ \_\  \ \_\    \ \_\ \_\  \ \_\    \ \_____\  \ \_\ \_\ 
  \/_/\/_/   \/_/     \/_/\/_/   \/_/     \/_____/   \/_/\/_/ 

Description

apafea is short for "alluvial plots as functional enrichment analysis".
And it does just that. Input a set of gene clusters (supports KeyPathwayMiner & BiCoN) and apafea performs gene set enrichment analysis and shows an alluvial plot visualizing the results.
For further Information check out usage.

Installation

Install the package with: pip install apafea

Usage

python:
from apafea import run

run(
    mode="KPM",
    data="/absolute/path/to/directory/",
    mode_2="BiCoN",
    data_2="/absolute/path/to/results.csv",
    gsea_dir="/absolute/path/to/gsea/directory/",
    GO=["bp",
        "cc",
        "mf",
        "pw"],
    PW=["KEGG",
        "Reactome",
        "WikiPathways",
        "MSigDB_C",
        "MSigDB_O_S"],
    all=False,
    cutoff=0.05,
)
explanation:
  • "mode" - defines the type of input.
    • "KPM" - give the path to your KeyPythwayMiner output directory under "data"
    • "BiCoN" - give the path to your BiCoN result .csv file under "data"
    • "custom" - give the path to your directory under "data" containing 1 cluster per file like this:
    gene1
    gene2
    ...
    
  • "mode_2" - defines the type of input for cluster comparison analysis.
    • "KPM" - same as above
    • "BiCoN" - same as above
    • "custom" - same as above
    • None / not set - cluster comparison analysis will not be performed
  • "gsea_dir" - give the path to a directory to be used as gene set enrichment analysis output directory (default: /tmp)
  • "GO" - list of GO-Terms enrichment analysis is being performed for
    • "bp" - Biological process
    • "cc" - Cellular Component
    • "mf" - molecular Function
    • "pw" - KEGG Pathways
    • None / [] / not set - analysis will not be performed
  • "PW" - list of pathway databases enrichment analysis is being performed for
    • "KEGG" - KEGG_2016
    • "Reactome" - Reactome_2016
    • "WikiPathways" - WikiPathways_2016
    • "MSigDB_C" - MSigDB_Computational
    • "MSigDB_O_S" - MSigDB_Oncogenic_Signatures
    • None / [] / not set - analysis will not be performed
  • "all" - associates all its terms to a gene (default: False)
  • "cutoff" - defines the cutoff for gene set enrichment analysis (default: 0.05)

History

  • 0.0.0 - initial commit
  • 0.0.1 - first official release
  • 0.0.2 - added MANIFEST.in and changed relative path handling for sample data
  • 0.0.3 - fixed bug with relative path handling for sample data

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apafea-0.0.3-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file apafea-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: apafea-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for apafea-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a219bc5706b40b1b8f9f25d9d22c7ecfdde38f47eac4d62d0792b96e94aa2b04
MD5 de85463d65c38693d44ffe512108d3c6
BLAKE2b-256 04c282b7d895fdc77a5eee37f1468f6609bce6872f03fb8ac2b30540ea4b84d9

See more details on using hashes here.

Supported by

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