Update projectMetadata

Updates the projectMetadata slot in a SpatialMap object to match values on the Enable Portal. As certain region-level metadata may be added or modified on the Enable Portal after a SpatialMap object is built (e.g. region display labels, visual quality, and clinical metadata), this function facilitates update of these metadata without the need to re-run spatialmap_from_db.

Usage

updateProjectMetadata(
  object,
  col.names = NULL,
  overwrite = TRUE,
  add.new = TRUE,
  expand_metadata = TRUE,
  connection = con,
  schema = "CORE_DATA",
  ds = -1
)

Arguments

object

A SpatialMap object

col.names

A character vector of existing columns in projectMetadata to update. If NULL, all will be updated.

overwrite

Whether to overwrite existing columns in projectMetadata in case of a column name match If FALSE, new columns will be appended instead (with the suffix "_upd")

add.new

Whether to add new metadata columns (newly added to database) to projectMetadata

expand_metadata

A logical indicating whether metadata columns should be expanded to the cellMetadata slot via mergeProjectMetadata(), to which overwrite is also passed.

connection

The database connection object

schema

The database schema name

ds

A date-stamp of today plus ds (an integer) is used to filter Snowflake queries.

Value

A SpatialMap object with an updated projectMetadata slot, and an updated cellMetadata slot (if expand_metadata = TRUE)