Skip to contents

Construct default metadata for a GDS object

Usage

gds_metadata(
  schema_version = "0.1.0",
  units = list(),
  provenance = list(graph = list(), log = character(), digest = NULL),
  software = list(package = "fmrigds", version = .pkg_version(), R_version =
    getRversion()),
  alignment = NULL,
  map_families = list(),
  mask_info = NULL,
  contrast_info = NULL,
  design_mats = NULL,
  notes = NULL,
  created = Sys.time()
)

Arguments

schema_version

Schema version string

units

Named list of assay units

provenance

Provenance structure (graph, log, digest)

software

Software metadata (package name, version, R version)

alignment

Optional alignment metadata

map_families

Named list of registered map families

mask_info

Optional mask metadata

contrast_info

Optional contrast metadata

design_mats

Optional design matrices metadata

notes

Optional user notes

created

Timestamp for when the metadata was created

Value

Metadata list