expose_property: Expose a property of xpdb objects in an xpose_set

In xpose.xtras: Extra Functionality for the 'xpose' Package

Expose a property of xpdb objects in an xpose_set

Description

Expose a property of xpdb objects in an xpose_set

Usage

expose_property(xpdb_s, ..., .problem = NULL, .subprob = NULL, .method = NULL)

Arguments

xpdb_s	<xpose_set> An xpose_set object
...	<dynamic-dots> One or more properties to expose
.problem	<numeric> Problem number to apply this relationship.
.subprob	<numeric> Problem number to apply this relationship.
.method	<numeric> Problem number to apply this relationship.

Details

The property returned will be top-level, and to avoid conflicting names will be prepended by .. (e.g., ..descr).

For some properties, transformations are applied automatically to make them more useful. This includes:

• etashk and epsshk: transformed to numeric vectors as in <get_shk>

• ofv and other per-problem properties: transformed as needed and pulls from each xpdb default problem.

Value

An xpose_set object with the properties exposed

See Also

expose_param()

Examples

xpdb_set <- expose_property(xpdb_set, descr)
xpdb_set$mod1$..descr

xpdb_set <- expose_property(xpdb_set, etashk)
xpdb_set$mod1$..etashk

xpose.xtras documentation built on April 4, 2025, 2:13 a.m.