Skip to contents

Register an assay type

Source: R/assay-registry.R
register_assay.Rd

Register an assay type

Usage

register_assay(
  name,
  role,
  units = NULL,
  variance_of = NULL,
  derive_from = NULL
)

Arguments

name

Assay name

role

Semantic category (e.g., "location", "variance", "stdev", "z", "t", "F", "df", "n_eff", "p", "chi2", "evidence", "log_evidence", "posterior")

units

Optional units string/list

variance_of

Optional name of the assay whose variance this represents

derive_from

Optional character vector of prerequisite assays

Value

Invisibly, the registered assay definition