Extract metadata from a Variable Mapper — var_id

var_id_info() extracts a consistent metadata structure from a Variable Mapper object. When processed is supplied, variable previews and count-based metadata are included in the result.

Usage

var_id_info(.var_id, processed = NULL, ...)

Arguments

.var_id: A Variable Mapper object from x_by(), rel(), pairwise(), or a formula.
processed: A named list returned by model_processor(), or NULL. When NULL, count-based fields in other_info and vars are omitted.
...: Currently unused.

Value

A class_var_inform S7 object with fields:

var_id: The original Variable Mapper object.
model_type: Derived from the class name of var_id.
args: A formatted string summarising the model's arguments. Defaults to "<?>" for unregistered subclasses.
other_info: A named list of model-type-specific metadata. Empty for unregistered subclasses.
vars: A list of lists with name and preview fields. Empty for unregistered subclasses or when processed is NULL.

Examples

# without processed — no vars, no counts
var_id_info(x_by(extra, group))
#> <statim::model_inform>
#>  @ var_id    : <statim::x_by>
#>  .. @ x    : language ~extra
#>  .. .. - attr(*, ".Environment")=<environment: 0x557b7b965820> 
#>  .. @ group: language ~group
#>  .. .. - attr(*, ".Environment")=<environment: 0x557b7b965820> 
#>  @ model_type: chr "x_by"
#>  @ args      : chr "extra | group"
#>  @ other_info: list()
#>  @ vars      : list()
#>  @ registered: logi TRUE

# with processed — includes vars and counts
dm = define_model(x_by(extra, group), sleep)
var_id_info(dm@var_id, dm@processed)
#> <statim::model_inform>
#>  @ var_id    : <statim::x_by>
#>  .. @ x    : language ~extra
#>  .. .. - attr(*, ".Environment")=<environment: 0x557b7b965820> 
#>  .. @ group: language ~group
#>  .. .. - attr(*, ".Environment")=<environment: 0x557b7b965820> 
#>  @ model_type: chr "x_by"
#>  @ args      : chr "extra | group"
#>  @ other_info:List of 2
#>  .. $ x_vars : int 1
#>  .. $ by_vars: int 1
#>  @ vars      :List of 2
#>  .. $ :List of 2
#>  ..  ..$ name   : chr "extra"
#>  ..  ..$ preview: chr "<dbl [20]>"
#>  .. $ :List of 2
#>  ..  ..$ name   : chr "group"
#>  ..  ..$ preview: chr "<fct [20]>"
#>  @ registered: logi TRUE