type_sum.param: Succinct summary of parameter objects

In topepo/dials: Tools for Creating Tuning Parameter Values

Succinct summary of parameter objects

Description

type_sum() controls how objects are shown when inside tibble columns.

Usage

## S3 method for class 'param'
type_sum(x)

Arguments

x	A param object to summarise.

Details

For param objects, the summary prefix is either "dparam" (if a qualitative parameter) or "nparam" (if quantitative). Additionally, brackets are used to indicate if there are unknown values. For example, "⁠nparam[?]⁠" would indicate that part of the numeric range is has not been finalized and "⁠nparam[+]⁠" indicates a parameter that is complete.

Value

A character value.

topepo/dials documentation built on June 17, 2024, 4:14 a.m.