Locate image files

Creates a named character() vector that can be helpful for locating image files and used with add_images(). This function is not necessary if the image files don't use the spe$sample_id.

locate_images(spe, image_dir, image_pattern)

Arguments

spe

Defaults to the output of fetch_data(type = 'spe'). This is a SpatialExperiment-class object with the spot-level Visium data and information required for visualizing the histology. See fetch_data() for more details.

image_dir

A character(1) specifying a path to a directory containing image files with the pattern sampleID_pattern.png.

image_pattern

A character(1) specifying the pattern for the image files.

Value

A named character() vector with the path to images.

See also

Other Functions for adding non-standard images: add_images()

Examples

if (FALSE) {
locate_images(spe, tempdir(), "testImage")
}