edit scuttle to scrapper for aggregateAcrossCells() - #123
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We noticed that the package test was breaking [here] after the warning message:
Warning in .local(x, ...) : 'aggregateAcrossCells' is deprecated.The
aggregateAcrossCells()function in thescuttlepackage is being phased out in favor of the newscrapperpackage ([scuttle issue #36](LTLA/scuttle#36 (comment))) and has also been replaced in recent Bioconductor updates, such as inimcRtools([Bioconductor 3.23 Release]. Additionally, internal arguments such asaveragehave been deprecated in favor ofstatisticslink.Implementation
The initial implementation directly replaced
scuttle::aggregateAcrossCells()withscrapper::aggregateAcrossCells(). However, the two functions work differently.scuttle::aggregateAcrossCells()accepts aSingleCellExperimentand returns aSingleCellExperiment, while thescrapper::aggregateAcrossCells()implementation currently available to us operates on a matrix-like input and returns a list containing the aggregated counts and grouping information (sums,detected,combinations,counts, andindex).Therefore, directly passing the
SingleCellExperimenttoscrapper::aggregateAcrossCells()resulted in:Error in dim(x) <- length(x) : invalid first argument, must be vector (list or atomic)The implementation was updated to aggregate the
countsmatrix withscrapper::aggregateAcrossCells()and reconstruct theSingleCellExperiment. The originalcolDatais also reconstructed, preserving the original column types and retaining the grouping variables (registration_variable,registration_sample_id) andncells, to reproduce the structure of the previousscuttleoutput.Validation
The updated
registration_pseudobulk()implementation was tested against the previousscuttleimplementation using the same example. The resultingSingleCellExperimentobjects are now identical using:testthat::expect_identical(sce_pseudo, test_pseudo)andtestthat::expect_equal(sce_pseudo, test_pseudo).@Nick-Eagles and @lahuuki helped to test this.