tests/testthat/test-seurat-manipulation.R

In bimberlabinternal/CellMembrane: A package with high-level wrappers and pipelines for single-cell RNA-seq tools

context("scRNAseq")

test_that("Seurat-manipulation works as expected", {
  set.seed(CellMembrane::GetSeed())

  seuratObj <- suppressWarnings(Seurat::UpdateSeuratObject(readRDS('../testdata/seuratOutput.rds')))

  seuratObj2 <- DownsampleSeurat(seuratObj, targetCells = 500)
  expect_equal(500, ncol(seuratObj2))
  
  seuratObj2 <- DownsampleSeurat(seuratObj, targetCells = 100, subsetFields = 'ClusterNames_0.2')
  expect_equal(493, ncol(seuratObj2))

  seuratObj2 <- DownsampleSeurat(seuratObj, targetCells = 100, subsetFields = c('ClusterNames_0.2'))
  expect_equal(493, ncol(seuratObj2))

  seuratObj2 <- DownsampleSeurat(seuratObj, targetCells = 100, subsetFields = c('ClusterNames_0.2', 'Phase'))
  expect_equal(1062, ncol(seuratObj2))

  seuratList <- SplitSeurat(seuratObj, splitField = 'ClusterNames_0.2')
  expect_equal(5, length(seuratList))

  seuratList <- SplitSeurat(seuratObj, splitField = 'ClusterNames_0.2', minCellsToKeep = 200, appendLowFreqToOther = FALSE)
  expect_equal(3, length(seuratList))

  df <- AvgExpression(seuratObj, groupField = 'ClusterNames_0.4')
  expect_equal(ncol(df), 8)
  expect_equal(nrow(df), nrow(seuratObj) + 2)
  expect_equal(max(df[df$feature == 'LibrarySize', colnames(df) %in% paste0('g', 0:5)]), 939113)

  seuratList <- SplitSeurat(seuratObj, splitField = 'ClusterNames_0.2', minCellsToKeep = 200)
  expect_equal(4, length(seuratList))

  seuratObj$Phase2 <- seuratObj$Phase
  seuratObj$Phase2[seuratObj$Phase == 'G1'] <- NA
  seuratList <- SplitSeurat(seuratObj, splitField = 'Phase2', minCellsToKeep = 200)
  expect_equal(3, length(seuratList))
  expect_equal(629, ncol(seuratList[['Other']]))
})

context("scRNAseq")

test_that("Seurat-saturation works as expected", {
	molInfoFile <- '../testdata/512-5-molecule_info.h5'
	df <- DropletUtils::get10xMolInfoStats(molInfoFile)
	df <- data.frame(cellbarcode = df$cell, num.umis = df$num.umis, CountsPerCell = df$num.reads)
	df <- df[df$CountsPerCell > 100,]

    # NOTE: this is converted into two features b/c Assay5 objects do not allow single-feature data
	dat <- Seurat::as.sparse(matrix(c(df$CountsPerCell, df$CountsPerCell), nrow = 2))
	colnames(dat) <- df$cellbarcode
	rownames(dat) <- c('Feat1', 'Feat2')
	
	seuratObj <- Seurat::CreateSeuratObject(dat)
	seuratObj <- AppendPerCellSaturation(seuratObj, molInfoFile)
	expect_equal(max(seuratObj$Saturation.RNA), 0.9765625)
	expect_equal(length(unique((seuratObj$Saturation.RNA))), 7126)
	expect_equal(sum(is.na(seuratObj$Saturation.RNA)), 0)
	expect_equal(sum(is.na(seuratObj$nReads_RNA)), 0)

	dat1 <- dat
	dat2 <- dat
	colnames(dat1) <- paste0('1234_', colnames(dat1))
  seuratObj <- Seurat::CreateSeuratObject(dat1)
  seuratObj$DatasetId <- 1234
  seuratObj$BarcodePrefix <- 1234
  
  colnames(dat2) <- paste0('12345_', colnames(dat2))
  seuratObj2 <- Seurat::CreateSeuratObject(dat2)
  seuratObj2$DatasetId <- 12345
  seuratObj2$BarcodePrefix <- 12345
  
  seuratObj3 <- CellMembrane::MergeSeuratObjs(seuratObjs = list('1234' = seuratObj, '12345' = seuratObj2), projectName = 'test')
  
  molInfoFileList <- list()
  molInfoFileList[['1234-RNA']] <- molInfoFile
  molInfoFileList[['12345-RNA']] <- molInfoFile

  seuratObj3 <- AppendPerCellSaturationInBulk(seuratObj3, molInfoFileList)
  expect_equal(max(seuratObj3$Saturation.RNA), 0.9765625)
  expect_equal(length(unique((seuratObj3$Saturation.RNA))), 7126)
  expect_equal(sum(is.na(seuratObj3$Saturation.RNA)), 0)
  expect_equal(sum(is.na(seuratObj3$nReads_RNA)), 0)
})

test_that("ScaleFeaturesIfNeeded works as expected", {
  set.seed(CellMembrane::GetSeed())
  
  seuratObj <- suppressWarnings(Seurat::UpdateSeuratObject(readRDS('../testdata/seuratOutput.rds')))
  
  seuratObj <- NormalizeAndScale(seuratObj, nVariableFeatures = 100)

  toAdd <- rownames(seuratObj@assays$RNA)[!rownames(seuratObj@assays$RNA) %in% rownames(Seurat::GetAssayData(seuratObj, assay = 'RNA', layer = 'scale.data'))][1:10]
  toAdd <- c(toAdd, rownames(Seurat::GetAssayData(seuratObj, assay = 'RNA', layer = 'scale.data'))[1:10])
  
  seuratObj2 <- ScaleFeaturesIfNeeded(seuratObj, toScale = toAdd)
  expect_equal(200, nrow(Seurat::GetAssayData(seuratObj2, assay = 'RNA', layer = 'scale.data')))
})

test_that("Assay meta.data works for Seurat 4 and 5", {
  seuratObj <- suppressWarnings(Seurat::UpdateSeuratObject(readRDS('../testdata/seuratOutput.rds')))
  
  assay <- Seurat::GetAssay(seuratObj)
  assay5 <- SeuratObject::CreateAssay5Object(counts = assay@counts)
  
  assay@meta.features$Test <- 'Seurat4'
  assay5@meta.data$Test <- 'Seurat5'
  
  slot(assay, GetAssayMetadataSlotName(assay))$NewCol <- 1
  assay@meta.features$NewCol
  expect_equal(unique(assay@meta.features$NewCol), 1)
  
  slot(assay5, GetAssayMetadataSlotName(assay5))$NewCol <- 2
  assay5@meta.data$NewCol
  expect_equal(unique(assay5@meta.data$NewCol), 2)
})