set_prop: Set a summary property

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

Set a summary property

Description

Set a summary property

Usage

set_prop(xpdb, ..., .problem = NULL, .subprob = NULL)

Arguments

xpdb	<xpose_dataxpose::xpose_data> object
...	<dynamic-dots> defining which properties to transform. Argument should be valid label.
.problem	<numeric> Problem number to use. Uses all problem if not provided.
.subprob	<numeric> Subproblem number to use. Uses the xpose default if not provided.

Details

Although one might be tempted to set custom properties using this function, with the intention to maintain cross-functionality with xpose, users cannot set a non-existent property with this function. When used internally, workarounds to this semi-limitation are used.

Value

xp_xtras object

Examples

set_prop(xpose::xpdb_ex_pk, descr = "New model description") %>%
  xpose::get_summary()

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