Skip to content

Commit

Permalink
adopt poetry
Browse files Browse the repository at this point in the history
Adopt poetry for package management and building, deprecating the setup
files as well as the requirements.txt.
Create first PyPi release.
Update readme accordingly.
  • Loading branch information
alan-barzilay committed Jul 21, 2022
1 parent 92016da commit 7cfab09
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 50 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
poetry.lock
Results
dist
*__pycache__
13 changes: 3 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
<p align="center">
<img src="./PEBBA_banner.png">
<img src="https://raw.githubusercontent.com/csbl-br/pebba/master/PEBBA_banner.png">
</p>

---------------------------------------

Over-representation analysis (ORA) is a critical technique to determine if a set of differentially expressed genes (DEGs) is enriched with genes from specific gene sets or pathways. However, the cut-off used to define the number of DEGs that are utilised significantly impacts ORA results. To overcome the arbitrary choice of a cut-off and identify cut-off-independent enriched pathways, we developed PEBBA. This user-friendly tool ranks genes based on their statistical and biological significance and then systematically performs ORA for different cut-offs. There is no need to shortlist genes or waste time fine-tuning parameters. By simplifying ORA, PEBBA can be employed to lighten users’ burdens concerning parameter choice and decrease false positives. By visually exploring the parameter space, users can draw more precise conclusions about their dataset.

## Install
To install pebba, first clone this repository and install its dependencies with `pip install -r requirements.txt`.
Then, install pebba in editable mode (unless you intend to deploy it in production, **do not** deploy it in editable mode): `pip install -e .`
PEBBA may be installed through pip: `pip install pebba`.
Alternatively, PEBBA is also available as an online tool at [pebba.sysbio.tools](https://pebba.sysbio.tools/)

(soon pebba will be uploaded to pypi, thus simplifying this process)

## Using pebba
Once installed, pebba can be used as a standalone module:
Expand All @@ -19,9 +18,3 @@ Once installed, pebba can be used as a standalone module:


For more options use the --help flag: `python -m pebba --help`

You can also use the test data to run a pebba analysis:

`python -m pebba tests/data/GSE49757_Septic_vs_Healthy.txt tests/data/Reactome_2016_15and100Genes.gmt `

PEBBA is also available as an online tool at [pebba.sysbio.tools](https://pebba.sysbio.tools/)
28 changes: 23 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
[tool.poetry]
name = "pebba"
version = "0.1.1"
description = "A tool for ORA meta-analysis"
authors = ["Alan Barzilay"]
license = "GPL-3.0-or-later"
readme = "README.md"
homepage = "https://pebba.sysbio.tools/"
repository = "https://github.com/csbl-br/pebba"

[tool.poetry.dependencies]
python = ">=3.8,<3.11"
scipy = "^1.8.1"
plotly = "^5.9.0"
numpy = "^1.23.1"
statsmodels = "^0.13.2"
pandas = "^1.4.3"

[tool.poetry.dev-dependencies]
pytest = "^7.1.2"

[build-system]
requires = [
"setuptools>=42",
"wheel"
]
build-backend = "setuptools.build_meta"
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"
5 changes: 0 additions & 5 deletions requirements.txt

This file was deleted.

24 changes: 0 additions & 24 deletions setup.cfg

This file was deleted.

6 changes: 0 additions & 6 deletions setup.py

This file was deleted.

0 comments on commit 7cfab09

Please sign in to comment.