Skip to content

Commit e6bafe2

Browse files
Update README.md
1 parent 92396da commit e6bafe2

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,20 @@ Using BCR sequences for graph embedding
44
[![R-CMD-check](https://github.com/BorchLab/Ibex/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/BorchLab/Ibex/actions/workflows/R-CMD-check.yaml)
55
[![Codecov test coverage](https://codecov.io/gh/BorchLab/Ibex/graph/badge.svg)](https://app.codecov.io/gh/BorchLab/Ibex?branch=master)
66
[![Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://www.borch.dev/uploads/screpertoire/articles/ibex)
7+
[![Bioc Release Build](http://www.bioconductor.org/shields/build/release/bioc/Ibex.svg)](http://www.bioconductor.org/checkResults/release/bioc-LATEST/Ibex)
8+
[![Bioc Devel Build](http://www.bioconductor.org/shields/build/devel/bioc/Ibex.svg)](http://www.bioconductor.org/checkResults/devel/bioc-LATEST/Ibex)
9+
[![Bioc Downloads](http://www.bioconductor.org/shields/downloads/release/Ibex.svg)](http://bioconductor.org/packages/stats/bioc/Ibex/)
710

811
<img align="right" src="https://github.com/BorchLab/Ibex/blob/main/www/ibex_hex.png" width="305" height="352">
912

10-
## Introduction
1113
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.
1214

1315
**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.
1416

15-
# System Requirements
17+
### System Requirements
1618
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.
1719

18-
# Installation
20+
### Installation
1921

2022
Ibex relies on the [immApex](https://github.com/BorchLab/immApex) API can be installed directly from GitHub:
2123

@@ -46,7 +48,7 @@ BiocManager::install("Ibex")
4648

4749
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.
4850

49-
# Usage/Demos
51+
### Usage/Demos
5052

5153
Ibex integrates smoothly into most popular R-based single-cell workflows, including **Seurat** and **Bioconductor/SingleCellExperiment.**
5254

@@ -56,7 +58,7 @@ See the [vignette](https://www.borch.dev/uploads/screpertoire/articles/ibex) for
5658

5759
<img align="center" src="https://github.com/BorchLab/Ibex/blob/main/www/graphicalAbstract.png">
5860

59-
## Autoencoded Matrix
61+
#### Autoencoded Matrix
6062

6163
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.
6264

@@ -65,7 +67,7 @@ library(Ibex)
6567
my_ibex <- Ibex_matrix(singleObject)
6668
```
6769

68-
## Seurat or Single-Cell Experiment
70+
#### Seurat or Single-Cell Experiment
6971

7072
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.
7173

@@ -82,7 +84,7 @@ seuratObj_Bonly <- runIbex(seuratObj, #The single cell object
8284
seuratObj_Bonly <- runIbex(seuratObj, reduction.name = "Ibex")
8385
```
8486

85-
## After Running Ibex
87+
#### After Running Ibex
8688

8789
Once the Ibex embeddings are part of your Seurat object, you can use these embeddings to generate a t-SNE or UMAP:
8890

@@ -99,7 +101,7 @@ seuratObj <- quietBCRgenes(seuratObj)
99101
seuratObj <- RunPCA(seuratObj)
100102
```
101103

102-
### Running WNN approach
104+
#### Running WNN approach
103105
```r
104106
seuratObj <- FindMultiModalNeighbors(seuratObj,
105107
reduction.list = list("pca", "Ibex"),

0 commit comments

Comments
 (0)