diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
index 8099b57..1e78e6b 100644
--- a/.github/workflows/docker.yml
+++ b/.github/workflows/docker.yml
@@ -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}}
@@ -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
diff --git a/Dockerfile b/Dockerfile
index d1c5123..8493c06 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,4 +1,4 @@
-FROM ghcr.io/bimberlabinternal/discvr-base:latest
+FROM ghcr.io/bimberlab/discvr-base:latest
ARG GH_PAT='NOT_SET'
diff --git a/README.md b/README.md
index d86e281..e76fa75 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-[](https://github.com/bimberlabinternal/RIRA/actions/workflows/R-CMD-check.yaml)
+[](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
@@ -10,28 +10,37 @@
### Overview
-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.
### Data
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)
### Usage Examples
```
-# 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')
```
@@ -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
```