prop_spec: A factory-built property's spec

View source: R/02_S7_prop_factories.R

prop_specR Documentation

A factory-built property's spec

Description

The machine-readable declaration behind a property: type, default, bounds, enum and description. Read it to generate documentation, a JSON Schema, or a defaults artifact from the class definition itself.

Usage

prop_spec(property)

Arguments

property

S7 property, from one of the ⁠prop_*⁠ factories.

Value

Named list of spec fields, or NULL if the property was not built by a ⁠prop_*⁠ factory.

Author(s)

EDG

Examples

temperature <- prop_float(default = 0.3, min = 0, max = 2)
prop_spec(temperature)[["maximum"]]

rtemis.core documentation built on Sept. 20, 2026, 9:06 a.m.