Contents

1 Overview

The BumpyMatrix class provides a representation of complex ragged data structures - see the BumpyMatrix package for more information. This is used to coerce immune repertoire, spatial transcriptomics and drug response data into a familiar 2D array for easy manipulation. The alabaster.bumpy package allows users to save a BumpyMatrix to file within the alabaster framework.

2 Saving a BumpyMatrix

Let’s make a BumpyMatrix to demonstrate:

library(BumpyMatrix)
library(S4Vectors)
df <- DataFrame(x=runif(100), y=runif(100))
f <- factor(sample(letters[1:20], nrow(df), replace=TRUE), letters[1:20])
mat <- BumpyMatrix(split(df, f), c(5, 4))

Saving it to file involves calling saveObject:

library(alabaster.bumpy)
tmp <- tempfile()
saveObject(mat, tmp)
list.files(tmp, recursive=TRUE)
## [1] "OBJECT"                        "concatenated/OBJECT"          
## [3] "concatenated/basic_columns.h5" "partitions.h5"

3 Loading a BumpyMatrix

The loading procedure is even simpler as the metadata of the saved BumpyMatrix remembers how it was saved. We can just use alabaster.base::readObject() or related functions, and the R interface will automatically do the rest.

readObject(tmp)
## 5 x 4 BumpyDataFrameMatrix
## rownames: NULL 
## colnames: NULL 
## preview [1,1]:
##   DataFrame with 6 rows and 2 columns
##             x         y
##     <numeric> <numeric>
##   1  0.720001 0.7620946
##   2  0.932493 0.5100523
##   3  0.301622 0.6267102
##   4  0.521526 0.1925033
##   5  0.147335 0.1595309
##   6  0.575149 0.0615692

Session info

sessionInfo()
## R version 4.4.1 (2024-06-14 ucrt)
## Platform: x86_64-w64-mingw32/x64
## Running under: Windows Server 2022 x64 (build 20348)
## 
## Matrix products: default
## 
## 
## locale:
## [1] LC_COLLATE=C                          
## [2] LC_CTYPE=English_United States.utf8   
## [3] LC_MONETARY=English_United States.utf8
## [4] LC_NUMERIC=C                          
## [5] LC_TIME=English_United States.utf8    
## 
## time zone: America/New_York
## tzcode source: internal
## 
## attached base packages:
## [1] stats4    stats     graphics  grDevices utils     datasets  methods  
## [8] base     
## 
## other attached packages:
## [1] alabaster.bumpy_1.6.0 alabaster.base_1.6.0  S4Vectors_0.44.0     
## [4] BiocGenerics_0.52.0   BumpyMatrix_1.14.0    BiocStyle_2.34.0     
## 
## loaded via a namespace (and not attached):
##  [1] cli_3.6.3               knitr_1.48              rlang_1.1.4            
##  [4] xfun_0.48               jsonlite_1.8.9          htmltools_0.5.8.1      
##  [7] sass_0.4.9              rmarkdown_2.28          grid_4.4.1             
## [10] evaluate_1.0.1          jquerylib_0.1.4         fastmap_1.2.0          
## [13] Rhdf5lib_1.28.0         alabaster.schemas_1.6.0 yaml_2.3.10            
## [16] IRanges_2.40.0          lifecycle_1.0.4         bookdown_0.41          
## [19] BiocManager_1.30.25     compiler_4.4.1          Rcpp_1.0.13            
## [22] rhdf5filters_1.18.0     rhdf5_2.50.0            lattice_0.22-6         
## [25] digest_0.6.37           R6_2.5.1                bslib_0.8.0            
## [28] Matrix_1.7-1            tools_4.4.1             cachem_1.1.0