Metadata-Version: 2.4
Name: xlranker
Version: 0.1.1
Summary: PPI-XL Ranking Tool
Requires-Python: >=3.10
Requires-Dist: biopython>=1.85
Requires-Dist: cyclopts>=3.15.0
Requires-Dist: networkx>=3.4.2
Requires-Dist: polars>=1.29.0
Requires-Dist: questionary>=2.1.0
Requires-Dist: scikit-learn>=1.6.1
Requires-Dist: xgboost>=3.0.0
Description-Content-Type: text/markdown

<div align="center">
<img src="docs/images/logo.svg" alt="Logo" width="80" height="80">
<h1 style="margin-top: -1pt; margin-bottom: 0pt">XLRanker</h1>
<!-- Badges -->
<a target="_blank" style="margin-top: 0pt" href="https://colab.research.google.com/github/bzhanglab/xlranker/blob/master/notebooks/xlranker_example.ipynb">
  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a>
</div><br>

XLRanker is a tool to rank and prioritize protein to protein cross linking data. The tool uses parsimonious selection as well as an XGBoost model to select the best protein pairs to represent ambiguous peptides.

## Installation

You can install `xlranker` using pip:

```bash
pip install xlranker
```

## Usage

To analyze a TSV file containing a network of peptide sequences run:

```
xlranker start peptide_network.tsv
```

Please view the [documentation](https://bzhanglab.github.io/xlranker/latest/) for detailed usage instructions and examples.

## Example Notebook

For a quick start, you can check out the example notebook in the `notebooks` directory or [launch a google colab notebook](https://colab.research.google.com/github/bzhanglab/xlranker/blob/master/notebooks/xlranker_example.ipynb) to see how to use the package interactively.
