Create SpatialMap Analysis — createAnalysis • SpatialMap

User interface for the creation and validation of a new Analysis class object. Provides input type, name, and dimension checking for Analysis class objects.

Usage

createAnalysis(
  sm.object,
  id = "combined",
  regions = NULL,
  silent = FALSE,
  features = NULL,
  representations = NULL,
  graphs = NULL
)

Arguments

sm.object: A SpatialMap object
id: The id / name of the Analysis
regions: The Regions to include in the Analysis
silent: Whether or not to print anything to the console
features: The features to include in the Analysis. By default, features are the unique set of features common to all Regions in the Analysis.
representations: If any explicit (pre-computed?) representations should be added to the Analysis object
graphs: If any explicit (pre-computed?) NN objects should be added to the Analysis object

Value

A SpatialMap object with a new Analysis for grouped analysis of Regions. The new Analysis will be set as the active Analysis (see activeAnalysis).

Details

See vignette("Quickstart_guide") for an example workflow showing use of this function and more info on the Analysis class.