# Spatial heterogeneity with SPIAT

Yuzhou Feng

#### 2023-05-24

#### Package

SPIAT 1.2.2

    library(SPIAT)

Cell colocalisation metrics allow capturing a dominant spatial pattern in an image. However, patterns are unlikely to be distributed evenly in a tissue, but rather there will be spatial heterogeneity of patterns. To measure this, SPIAT splits the image into smaller images (either using a grid or concentric circles around a reference cell population), followed by calculation of a spatial metric of a pattern of interest (e.g. cell colocalisation, entropy), and then measures the Prevalence and Distinctiveness of the pattern.

In this vignette we will use an inForm data file that’s already been formatted for SPIAT with `format_image_to_spe()`, which we can load with `data()`. We will use `define_celltypes()` to define the cells with certain combinations of markers.

    data("simulated_image")

    # define cell types
    formatted_image <- define_celltypes(
        simulated_image,
        categories = c("Tumour_marker","Immune_marker1,Immune_marker2",
                       "Immune_marker1,Immune_marker3",
                       "Immune_marker1,Immune_marker2,Immune_marker4", "OTHER"),
        category_colname = "Phenotype",
        names = c("Tumour", "Immune1", "Immune2", "Immune3", "Others"),
        new_colname = "Cell.Type")

# 1 Localised Entropy

Entropy in spatial analysis refers to the balance in the number of cells of distinct populations. An entropy score can be obtained for an entire image. However, the entropy of one image does not provide us spatial information of the image.

    calculate_entropy(formatted_image, cell_types_of_interest = c("Immune1","Immune2"),
                      feature_colname = "Cell.Type")

    ## [1] 0.9294873

We therefore propose the concept of Localised Entropy which calculates an entropy score for a predefined local region. These local regions can be calculated as defined in the next two sections.

## 1.1 Fishnet grid

One approach to calculate localised metric is to split the image into fishnet grid squares. For each grid square, `grid_metrics()` calculates the metric for that square and visualise the raster image. Users can choose any metric as the localised metric. Here we use entropy as an example.

For cases where the localised metric is not symmetrical (requires specifying a target and reference cell type), the first item in the vector used for `cell_types_of_interest` marks the reference cells and the second item the target cells. Here we are using Entropy, which is symmetrical, so we can use any order of cell types in the input.

    data("defined_image")
    grid <- grid_metrics(defined_image, FUN = calculate_entropy, n_split = 20,
                         cell_types_of_interest=c("Tumour","Immune3"),
                         feature_colname = "Cell.Type")

After calculating the localised entropy for each of the grid squares, we can apply metrics like percentages of grid squares with patterns (Prevalence) and Moran’s I (Distinctiveness).

For the Prevalence, we need to select a threshold over which grid squares are considered ‘positive’ for the pattern. The selection of threshold depends on the pattern and metric the user chooses to find the localised pattern. Here we chose 0.75 for entropy because 0.75 is roughly the entropy of two cell types when their ratio is 1:5 or 5:1.

    calculate_percentage_of_grids(grid, threshold = 0.75, above = TRUE)

    ## [1] 13

    calculate_spatial_autocorrelation(grid, metric = "globalmoran")

    ## [1] 0.09446964

## 1.2 Gradients (based on concentric circles)

We can use the `compute_gradient()` function to calculate metrics (entropy, mixing score, percentage of cells within radius, marker intensity) for a range of radii from reference cells. Here, an increasing circle is drawn around each cell of the reference cell type and the desired score is calculated for cells within each circle.

The first item in the vector used for `cell_types_of_interest` marks the reference cells and the second item the target cells. Here, Immune1 cells are reference cells and Immune2 are target cells.

    gradient_positions <- c(30, 50, 100)
    gradient_entropy <-
      compute_gradient(defined_image, radii = gradient_positions,
                       FUN = calculate_entropy,  cell_types_of_interest = c("Immune1","Immune2"),
                       feature_colname = "Cell.Type")
    length(gradient_entropy)

    ## [1] 3

    head(gradient_entropy[[1]])

    ##         Cell.X.Position Cell.Y.Position Immune1 Immune2 total Immune1_log2
    ## Cell_15       109.67027        17.12956       1       0     1            0
    ## Cell_25       153.22795       128.29915       1       0     1            0
    ## Cell_30        57.29037        49.88533       1       0     1            0
    ## Cell_48        83.47798       295.75058       2       0     2            1
    ## Cell_56        35.24227       242.84862       1       0     1            0
    ## Cell_61       156.39943       349.08154       2       0     2            1
    ##         Immune2_log2 total_log2 Immune1ratio Immune1_entropy Immune2ratio
    ## Cell_15            0          0            1               0            0
    ## Cell_25            0          0            1               0            0
    ## Cell_30            0          0            1               0            0
    ## Cell_48            0          1            1               0            0
    ## Cell_56            0          0            1               0            0
    ## Cell_61            0          1            1               0            0
    ##         Immune2_entropy entropy
    ## Cell_15               0       0
    ## Cell_25               0       0
    ## Cell_30               0       0
    ## Cell_48               0       0
    ## Cell_56               0       0
    ## Cell_61               0       0

The `compute_gradient()` function outputs the numbers cells within each radii for each reference cell. The output is formatted as a list of data.frames, one for each specified radii. In each data.frame, the rows show the reference cells. The last column of the data.frame is the entropy calculated for cells in the circle of the reference cell. Users can then an average score or another aggregation metric to report the results.

An alternative approach is to combine the results of all the circles (rather than have one for each individual reference cell). Here, for each radii, we simultaneously identify all the cells in the circles surrounding each reference cell, and calculate a single entropy score. We have created a specific function for this - `entropy_gradient_aggregated()`. The output of this function is an overall entropy score for each radii.

    gradient_pos <- seq(50, 500, 50) ##radii
    gradient_results <- entropy_gradient_aggregated(defined_image, cell_types_of_interest = c("Immune3","Tumour"),
                                                    feature_colname = "Cell.Type", radii = gradient_pos)
    # plot the results
    plot(1:10,gradient_results$gradient_df[1, 3:12])

# 2 You can access the vignettes for other modules of SPIAT here:

- Overview of SPIAT
- Data reading and formatting
- Quality control and visualisation
- Basic analysis
- Cell colocalisation
- Tissue structure
- Cellular neighborhood

# 3 Reproducibility

    sessionInfo()

    ## R version 4.3.0 RC (2023-04-13 r84269)
    ## Platform: x86_64-pc-linux-gnu (64-bit)
    ## Running under: Ubuntu 22.04.2 LTS
    ##
    ## Matrix products: default
    ## BLAS:   /home/biocbuild/bbs-3.17-bioc/R/lib/libRblas.so
    ## LAPACK: /usr/lib/x86_64-linux-gnu/lapack/liblapack.so.3.10.0
    ##
    ## locale:
    ##  [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C
    ##  [3] LC_TIME=en_GB              LC_COLLATE=C
    ##  [5] LC_MONETARY=en_US.UTF-8    LC_MESSAGES=en_US.UTF-8
    ##  [7] LC_PAPER=en_US.UTF-8       LC_NAME=C
    ##  [9] LC_ADDRESS=C               LC_TELEPHONE=C
    ## [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
    ##
    ## time zone: America/New_York
    ## tzcode source: system (glibc)
    ##
    ## attached base packages:
    ## [1] stats4    stats     graphics  grDevices utils     datasets  methods
    ## [8] base
    ##
    ## other attached packages:
    ##  [1] SPIAT_1.2.2                 SpatialExperiment_1.10.0
    ##  [3] SingleCellExperiment_1.22.0 SummarizedExperiment_1.30.1
    ##  [5] Biobase_2.60.0              GenomicRanges_1.52.0
    ##  [7] GenomeInfoDb_1.36.0         IRanges_2.34.0
    ##  [9] S4Vectors_0.38.1            BiocGenerics_0.46.0
    ## [11] MatrixGenerics_1.12.0       matrixStats_0.63.0
    ## [13] BiocStyle_2.28.0
    ##
    ## loaded via a namespace (and not attached):
    ##   [1] RColorBrewer_1.1-3        shape_1.4.6
    ##   [3] jsonlite_1.8.4            magrittr_2.0.3
    ##   [5] spatstat.utils_3.0-3      magick_2.7.4
    ##   [7] farver_2.1.1              rmarkdown_2.21
    ##   [9] GlobalOptions_0.1.2       zlibbioc_1.46.0
    ##  [11] vctrs_0.6.2               Cairo_1.6-0
    ##  [13] spatstat.explore_3.2-1    DelayedMatrixStats_1.22.0
    ##  [15] RCurl_1.98-1.12           elsa_1.1-28
    ##  [17] terra_1.7-29              htmltools_0.5.5
    ##  [19] S4Arrays_1.0.4            raster_3.6-20
    ##  [21] Rhdf5lib_1.22.0           rhdf5_2.44.0
    ##  [23] sass_0.4.6                pracma_2.4.2
    ##  [25] bslib_0.4.2               htmlwidgets_1.6.2
    ##  [27] mmand_1.6.3               plyr_1.8.8
    ##  [29] plotly_4.10.1             cachem_1.0.8
    ##  [31] lifecycle_1.0.3           iterators_1.0.14
    ##  [33] pkgconfig_2.0.3           Matrix_1.5-4.1
    ##  [35] R6_2.5.1                  fastmap_1.1.1
    ##  [37] clue_0.3-64               GenomeInfoDbData_1.2.10
    ##  [39] digest_0.6.31             colorspace_2.1-0
    ##  [41] tensor_1.5                dqrng_0.3.0
    ##  [43] crosstalk_1.2.0           beachmat_2.16.0
    ##  [45] labeling_0.4.2            fansi_1.0.4
    ##  [47] spatstat.sparse_3.0-1     httr_1.4.6
    ##  [49] polyclip_1.10-4           abind_1.4-5
    ##  [51] compiler_4.3.0            bit64_4.0.5
    ##  [53] withr_2.5.0               doParallel_1.0.17
    ##  [55] BiocParallel_1.34.2       apcluster_1.4.10
    ##  [57] highr_0.10                HDF5Array_1.28.1
    ##  [59] R.utils_2.12.2            DelayedArray_0.26.3
    ##  [61] rjson_0.2.21              gtools_3.9.4
    ##  [63] tools_4.3.0               goftest_1.2-3
    ##  [65] R.oo_1.25.0               glue_1.6.2
    ##  [67] dbscan_1.1-11             nlme_3.1-162
    ##  [69] rhdf5filters_1.12.1       grid_4.3.0
    ##  [71] Rtsne_0.16                cluster_2.1.4
    ##  [73] reshape2_1.4.4            generics_0.1.3
    ##  [75] gtable_0.3.3              spatstat.data_3.0-1
    ##  [77] tzdb_0.4.0                R.methodsS3_1.8.2
    ##  [79] tidyr_1.3.0               data.table_1.14.8
    ##  [81] sp_1.6-0                  utf8_1.2.3
    ##  [83] XVector_0.40.0            spatstat.geom_3.2-1
    ##  [85] ggrepel_0.9.3             RANN_2.6.1
    ##  [87] foreach_1.5.2             pillar_1.9.0
    ##  [89] stringr_1.5.0             vroom_1.6.3
    ##  [91] limma_3.56.1              circlize_0.4.15
    ##  [93] dplyr_1.1.2               lattice_0.21-8
    ##  [95] bit_4.0.5                 deldir_1.0-9
    ##  [97] tidyselect_1.2.0          ComplexHeatmap_2.16.0
    ##  [99] locfit_1.5-9.7            scuttle_1.10.1
    ## [101] knitr_1.42                gridExtra_2.3
    ## [103] bookdown_0.34             edgeR_3.42.2
    ## [105] xfun_0.39                 dittoSeq_1.12.0
    ## [107] DropletUtils_1.20.0       pheatmap_1.0.12
    ## [109] stringi_1.7.12            lazyeval_0.2.2
    ## [111] yaml_2.3.7                evaluate_0.21
    ## [113] codetools_0.2-19          archive_1.1.5
    ## [115] tibble_3.2.1              BiocManager_1.30.20
    ## [117] cli_3.6.1                 munsell_0.5.0
    ## [119] jquerylib_0.1.4           Rcpp_1.0.10
    ## [121] spatstat.random_3.1-5     png_0.1-8
    ## [123] parallel_4.3.0            ggplot2_3.4.2
    ## [125] sparseMatrixStats_1.12.0  bitops_1.0-7
    ## [127] viridisLite_0.4.2         scales_1.2.1
    ## [129] ggridges_0.5.4            purrr_1.0.1
    ## [131] crayon_1.5.2              GetoptLong_1.0.5
    ## [133] rlang_1.1.1               cowplot_1.1.1

# 4 Author Contributions

AT, YF, TY, ML, JZ, VO, MD are authors of the package code. MD and YF wrote the vignette. AT, YF and TY designed the package.