img_update: Update the image for one sample

In LieberInstitute/spatialLIBD: spatialLIBD: an R/Bioconductor package to visualize spatially-resolved transcriptomics data

Update the image for one sample

Description

Edit the image with img_edit() then update the imgData().

Usage

img_update(
  spe,
  sampleid,
  image_id = "lowres",
  new_image_id = paste0("edited_", image_id),
  overwrite = FALSE,
  ...
)

Arguments

spe	A SpatialExperiment-class object. See fetch_data() for how to download some example objects or read10xVisiumWrapper() to read in spaceranger --count output files and build your own spe object.
sampleid	A character(1) specifying which sample to plot from colData(spe)$sample_id (formerly colData(spe)$sample_name).
image_id	A character(1) with the name of the image ID you want to use in the background.
new_image_id	A character(1) specifying the new image_id to use.
overwrite	A logical(1) specifying whether to overwrite the image_id if it already exists.
...	Parameters passed to img_edit().

Value

A SpatialExperiment-class object with an updated imgData() slot.

See Also

Other Image editing functions: img_edit(), img_update_all()

Examples

if (enough_ram()) {
    ## Obtain the necessary data
    if (!exists("spe")) spe <- fetch_data("spe")

    ## Reduce brightness to 25% and update the imgData()
    imgData(img_update(spe, sampleid = "151507", brightness = 25))
}

LieberInstitute/spatialLIBD documentation built on Nov. 4, 2024, 11:57 a.m.