Skip to contents

Create a MockData specification

Source: R/mock_spec.R
mock_spec.Rd

mock_spec() creates the normalized v0.4 specification object used by the new architecture. Direct APIs and recodeflow adapters should both normalize into this shape before validation and generation.

Usage

mock_spec(
  ...,
  spec_version = .mock_spec_version,
  provenance = list(adapter = "direct", source = "direct"),
  model_hint = "auto",
  validate = TRUE
)

Arguments

...

mock_spec_variable objects, or a single list of them. NULL creates an empty specification.

spec_version

Character version of the specification shape.

provenance

List or character describing where the spec came from.

model_hint

Character backend hint. One of the supported MockData model hints.

validate

Logical. If TRUE, validate the constructed specification before returning it.

Value

S3 object of class mock_spec.

Details

The v0.4 API is layered. The mock_*() helpers are the simple direct API for one-variable specifications. The mock_spec_*() constructors create variable specifications that can be composed with mock_spec(). Metadata adapters, such as mock_spec_from_recodeflow(), translate external metadata into the same internal shape. Generation backends consume mock_spec objects rather than re-reading user-facing metadata.

See also

mock_continuous(), mock_categorical(), mock_date(), mock_spec_from_recodeflow(), generate_mock_data_native(), postprocess_mock_data()

Other mock specification APIs: mock_spec_categorical(), mock_spec_continuous(), mock_spec_date(), mock_spec_from_recodeflow()

Examples

spec <- mock_spec(
  mock_spec_continuous("age", range = c(18, 85), rtype = "integer"),
  mock_spec_categorical(
    "smoking",
    levels = c("never", "former", "current"),
    proportions = c(0.5, 0.3, 0.2)
  )
)
validate_mock_spec(spec)
#> MockData mock_spec validation result: valid