More automatic capture of TCR updates

Author: bbimber

singlecell/resources/chunks/ClassifyTNKByExpression.R

@@ -11,7 +11,7 @@ for (datasetId in names(seuratObjects)) {
   printName(datasetId)
   seuratObj <- readSeuratRDS(seuratObjects[[datasetId]])
 
-  if (!'HasCDR3Data' %in% names(seuratObj@meta.data)) {
+  if (.ShouldReapplyTcr(seuratObj)) {
     seuratObj <- Rdiscvr::DownloadAndAppendTcrClonotypes(seuratObj)
   }
 

singlecell/resources/chunks/Functions.R

@@ -191,3 +191,13 @@ if (Sys.getenv('SEURAT_MAX_THREADS') != '') {
 
     future::plan(strategy = fs, workers = mt)
 }
+
+.ShouldReapplyTcr <- function(seuratObj) {
+  return (
+    !'HasCDR3Data' %in% names(seuratObj@meta.data) ||
+    'TRB_Segments' %in% names(seuratObj@meta.data) ||
+      !'TRB_WithProductive' %in% names(seuratObj@meta.data) ||
+      # This purpose of this is to catch a previous bug where every cell was tagged as (NP)
+      (sum(seuratObj@meta.data$TRB_WithProductive, pattern = '(NP)' == sum(!is.na(seuratObj@meta.data$TRB_WithProductive))))
+  )
+}

singlecell/resources/chunks/IdentifyAndStoreActiveClonotypes.R

@@ -11,7 +11,7 @@ for (datasetId in names(seuratObjects)) {
   printName(datasetId)
   seuratObj <- readSeuratRDS(seuratObjects[[datasetId]])
 
-  if (! 'TRB_WithProductive' %in% names(seuratObj@meta.data)) {
+  if (.ShouldReapplyTcr(seuratObj)) {
     print('Re-running AppendTcr to add segment columns')
     seuratObj <- Rdiscvr::DownloadAndAppendTcrClonotypes(seuratObj, allowMissing = TRUE)
   }

singlecell/resources/chunks/PredictTcellActivation.R

@@ -11,7 +11,7 @@ for (datasetId in names(seuratObjects)) {
   printName(datasetId)
   seuratObj <- readSeuratRDS(seuratObjects[[datasetId]])
 
-  if (! 'TRB_WithProductive' %in% names(seuratObj@meta.data)) {
+  if (.ShouldReapplyTcr(seuratObj)) {
     print('Re-running AppendTcr to add segment columns')
     seuratObj <- Rdiscvr::DownloadAndAppendTcrClonotypes(seuratObj, allowMissing = TRUE)
   }
@@ -24,11 +24,6 @@ for (datasetId in names(seuratObjects)) {
     }
   }
 
-  if (! 'TRB_Segments' %in% names(seuratObj@meta.data)) {
-    print('Re-running AppendTcr to add segment columns')
-    seuratObj <- Rdiscvr::DownloadAndAppendTcrClonotypes(seuratObj, allowMissing = TRUE)
-  }
-
   seuratObj <- RIRA::PredictTcellActivation(seuratObj)
 
   saveData(seuratObj, datasetId)

singlecell/resources/chunks/SummarizeTCellActivation.R

@@ -11,7 +11,7 @@ for (datasetId in names(seuratObjects)) {
     printName(datasetId)
     seuratObj <- readSeuratRDS(seuratObjects[[datasetId]])
 
-    if (!'HasCDR3Data' %in% names(seuratObj@meta.data)){
+    if (.ShouldReapplyTcr(seuratObj)){
         seuratObj <- seuratObj <- Rdiscvr::DownloadAndAppendTcrClonotypes(seuratObj, allowMissing = FALSE)
     }
 

singlecell/resources/chunks/UpdateSeuratPrototype.R

@@ -21,16 +21,16 @@ for (datasetId in names(seuratObjects)) {
     seuratObj <- Rdiscvr::QueryAndApplyCdnaMetadata(seuratObj)
   }
 
+  if (applyTCR) {
+    seuratObj <- Rdiscvr::DownloadAndAppendTcrClonotypes(seuratObj, allowMissing = allowMissingTcr)
+  }
+
   if (runRira) {
     seuratObj <- RIRA::Classify_ImmuneCells(seuratObj, maxBatchSize = maxBatchSize, retainProbabilityMatrix = retainProbabilityMatrix)
     seuratObj <- RIRA::Classify_TNK(seuratObj, maxBatchSize = maxBatchSize, retainProbabilityMatrix = retainProbabilityMatrix)
     seuratObj <- RIRA::Classify_Myeloid(seuratObj, maxBatchSize = maxBatchSize, retainProbabilityMatrix = retainProbabilityMatrix)
   }
 
-  if (applyTCR) {
-    seuratObj <- Rdiscvr::DownloadAndAppendTcrClonotypes(seuratObj, allowMissing = allowMissingTcr)
-  }
-
   if (runTNKClassification) {
     # ClassifyTNKByExpression will fail without this, so ignore allowMissingTcr
     if (!'HasCDR3Data' %in% names(seuratObj@meta.data)) {