Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversion from & to SingleCellExperiment #212

Merged
merged 24 commits into from
Feb 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ export(from_SingleCellExperiment)
export(generate_dataset)
export(read_h5ad)
export(to_Seurat)
export(to_SingleCellExperiment)
export(write_h5ad)
importFrom(Matrix,as.matrix)
importFrom(Matrix,sparseMatrix)
Expand Down
33 changes: 31 additions & 2 deletions R/AbstractAnnData.R
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,37 @@ AbstractAnnData <- R6::R6Class("AbstractAnnData", # nolint
names(self$uns)
},
#' @description Convert to SingleCellExperiment
to_SingleCellExperiment = function() {
to_SingleCellExperiment(self)
#'
#' See [to_SingleCellExperiment()] for more details on the conversion.
#'
#' @param assays_mapping A named list mapping SingleCellExperiment assays to AnnData layers
#' @param colData_mapping A named list mapping SingleCellExperiment colData to AnnData obs
#' @param rowData_mapping A named list mapping SingleCellExperiment rowData to AnnData var
#' @param reduction_mapping A named list mapping SingleCellExperiment reductions to AnnData obsm/varm
#' @param colPairs_mapping A named list mapping SingleCellExperiment colPairs to AnnData obsp/varp
#' @param rowPairs_mapping A named list mapping SingleCellExperiment rowPairs to AnnData obsp/varp
#' @param metadata_mapping A named list mapping SingleCellExperiment metadata to AnnData uns
#'
#' @return A SingleCellExperiment object
to_SingleCellExperiment = function(
assays_mapping = NULL,
colData_mapping = NULL, # nolint
rowData_mapping = NULL, # nolint
reduction_mapping = NULL,
colPairs_mapping = NULL, # nolint
rowPairs_mapping = NULL, # nolint
metadata_mapping = NULL
) {
to_SingleCellExperiment(
self,
assays_mapping = assays_mapping,
colData_mapping = colData_mapping,
rowData_mapping = rowData_mapping,
reduction_mapping = reduction_mapping,
colPairs_mapping = colPairs_mapping, # nolint
rowPairs_mapping = rowPairs_mapping, # nolint
metadata_mapping = metadata_mapping
)
},
#' @description Convert to Seurat
#'
Expand Down
Loading
Loading