Skip to content

Commit

Permalink
Switch bimberlabinternal -> bimberlab
Browse files Browse the repository at this point in the history
  • Loading branch information
bbimber committed Sep 19, 2024
1 parent 3a883fe commit 538d401
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 12 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
id: docker_meta
uses: docker/metadata-action@v5
with:
images: ghcr.io/bimberlabinternal/rira
images: ghcr.io/bimberlab/rira
tags: |
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
Expand Down Expand Up @@ -52,7 +52,7 @@ jobs:
"GH_PAT=${{ secrets.PAT }}"
pull: true
push: ${{github.ref == 'refs/heads/master'}}
tags: ghcr.io/bimberlabinternal/rira:nightly,ghcr.io/bimberlabinternal/rira:latest
tags: ghcr.io/bimberlab/rira:nightly,ghcr.io/bimberlab/rira:latest
labels: |
${{ steps.docker_meta.outputs.labels }}
org.opencontainers.image.title=rira
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM ghcr.io/bimberlabinternal/discvr-base:latest
FROM ghcr.io/bimberlab/discvr-base:latest

ARG GH_PAT='NOT_SET'

Expand Down
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![R Build and Checks](https://github.com/bimberlabinternal/RIRA/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/bimberlabinternal/RIRA/actions/workflows/R-CMD-check.yaml)
[![R Build and Checks](https://github.com/bimberlab/RIRA/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/bimberlab/RIRA/actions/workflows/R-CMD-check.yaml)

## Rhesus Immunome Reference Atlas (RIRA): A multi-tissue single-cell landscape of immune cells

Expand All @@ -10,28 +10,37 @@

### <a name = "overview">Overview</a>

RIRA is a multi-tissue single-cell RNAseq atlas from Rhesus macaque cells.
RIRA is a multi-tissue single-cell RNA-seq atlas from Rhesus macaque cells, including data from 7 tissues and 47 animals.
It provides highly annotated reference data, and a number of pipelines to assign cell type to your data using RIRA's built-in models.
Finally, it includes pipelines to replicate the process used to generate RIRA's reference labels, which might be useful for generating a similar reference for another species.

### <a name = "usage">Data</a>

RIRA's data was generated and labeled using the following process:
1) Merge data from XX 10x Genomics datasets, representing 8 tissues and XX rhesus macaques
1) Merge data from all animals.
2) Perform strict QC and filtration, based on metrics such as per-cell RNA saturation
3) For initial phenotyping, we used scGate with a set of rhesus-adapted gates to divide cells. This initial pass is lossy, and will not label all cells.
4) Cells labeled by scGate were downsampled to equalize cells per class, and then fed as training data to celltypist. The resulting model (RIRA_Immune_v2) is available through this R package.
5) The above model will classify cells into course bins (T/NK, Bcell, MoMacDC, and Other). For many analyses we find it useful to subdivide a dataset into these categories and then perform dimensionality reduction on these more homogenous subsets.
5) The above model will classify cells into course bins (T/NK, Bcell, Myeloid, and Other). For many analyses we find it useful to subdivide a dataset into these categories and then perform dimensionality reduction on these more homogenous subsets.
6) RIRA provides a handful of models trained to identify more specific subsets (such as differentiating CD4 vs CD8 T cells)

### <a name = "usage">Usage Examples</a>

```
# Use the built-in celltypist model to score cells according to course phenotypes (T/NK, Bcell, MoMacDC, Other):
# Use the built-in celltypist model to score cells according to course phenotypes (T/NK, Bcell, Myeloid, Other):
seuratObj <- RIRA::RunCellTypist(seuratObj, modelName = ‘RIRA_Immune_v2’)
Seurat::DimPlot(seuratObj, group.by = 'RIRA_Immune_v2.cellclass')
# Also the built-in celltypist model for finer scope T/NK lineage:
# Also the built-in celltypist model for finer scope T/NK or myeloid cells:
seuratObj <- RIRA::Classify_TNK(seuratObj)
Seurat::DimPlot(seuratObj, group.by = 'RIRA_TNK_v2.cellclass')
seuratObj <- RIRA::Classify_Myeloid(seuratObj)
Seurat::DimPlot(seuratObj, group.by = 'RIRA_Myeloid_v3.cellclass')
# USing sorted T cell data, we empirically defined a gene component that can classify T cells by naive-to-memory differentiation:
seuratObj <- ScoreUsingSavedComponent(seuratObj, componentOrName = 'Tcell_EffectorDifferentiation', fieldName = 'EDS')
Seurat::FeaturePlot(seuratObj, features = 'EDS')
```

Expand All @@ -43,11 +52,11 @@ seuratObj <- RIRA::Classify_TNK(seuratObj)
local({options(repos = BiocManager::repositories())})
#Latest version:
devtools::install_github(repo = 'bimberlabinternal/RIRA', ref = 'master', dependencies = TRUE, upgrade = 'always')
devtools::install_github(repo = 'bimberlab/RIRA', ref = 'master', dependencies = TRUE, upgrade = 'always')
```

Pre-packaged Docker images with all needed dependencies installed can be found on our [GitHub Packages page](https://github.com/orgs/BimberLabInternal/RIRA/pkgs/container/rira). We recommend using a specific release, which you can do using tags:
Pre-packaged Docker images with all needed dependencies installed can be found on our [GitHub Packages page](https://github.com/orgs/bimberlab/RIRA/pkgs/container/rira). We recommend using a specific release, which you can do using tags:

```
docker pull ghcr.io/bimberlabinternal/rira:latest
docker pull ghcr.io/bimberlab/rira:latest
```

0 comments on commit 538d401

Please sign in to comment.