You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Single-cell sequencing is an integral tool in immunology and oncology, enabling researchers to measure gene expression and immune cell receptor profiling at the level of individual cells. We developed the [scRepertoire](https://github.com/BorchLab/scRepertoire) R package to facilitate the integration of immune receptor and gene expression data. However, leveraging clonal indices for more complex analyses—such as using clonality in cell embedding—remains challenging.
12
14
13
15
**Ibex** addresses this need by using deep learning to vectorize BCR sequences based on amino acid properties or their underlying order. Ibex is the sister package to [Trex](https://github.com/BorchLab/Trex), which focuses on TCR sequence data.
14
16
15
-
# System Requirements
17
+
###System Requirements
16
18
Ibex has been tested on R versions >= 4.0. For details on required R packages, refer to the package’s DESCRIPTION file. It is designed to work with single-cell objects containing BCR data generated using [scRepertoire](https://github.com/BorchLab/scRepertoire). Ibex has been tested on macOS and Linux.
17
19
18
-
# Installation
20
+
###Installation
19
21
20
22
Ibex relies on the [immApex](https://github.com/BorchLab/immApex) API can be installed directly from GitHub:
21
23
@@ -46,7 +48,7 @@ BiocManager::install("Ibex")
46
48
47
49
The main version of Ibex is submitted to Bioconductor (installation instructions will be updated after review). By default, Ibex will automatically pull deep learning models from a [Zenodo repository](https://zenodo.org/records/14919286) and cache them locally.
48
50
49
-
# Usage/Demos
51
+
###Usage/Demos
50
52
51
53
Ibex integrates smoothly into most popular R-based single-cell workflows, including **Seurat** and **Bioconductor/SingleCellExperiment.**
52
54
@@ -56,7 +58,7 @@ See the [vignette](https://www.borch.dev/uploads/screpertoire/articles/ibex) for
The Ibex algorithm allows users to select BCR-based metrics to return autoencoded values to be used in dimensional reduction. If single-cell objects are not filtered for B cells with BCR, `Ibex_matrix()` will still return values, however IBEX_1 will be based on the disparity of BCR-containing and BCR-non-containing cells based on the Ibex algorithm.
62
64
@@ -65,7 +67,7 @@ library(Ibex)
65
67
my_ibex<- Ibex_matrix(singleObject)
66
68
```
67
69
68
-
## Seurat or Single-Cell Experiment
70
+
####Seurat or Single-Cell Experiment
69
71
70
72
You can run Ibex within your Seurat or Single-Cell Experiemt workflow. **Importantly**`runIbex()` will automatically filter single-cells that do not contain BCR information in the meta data of the single-cell object.
0 commit comments