rtemis (version 1.4.3)

describe: Describe object

Description

Describe object

Usage

describe(x, verbosity = 1L, ...)

Value

Character, invisibly.

Arguments

x

R object to describe. See method documentation for supported classes.

verbosity

Integer: Verbosity level.

...

Additional arguments passed to methods.

Author

EDG

Details

Extra arguments for factor method:

• max_n: Integer: Return counts for up to this many levels.

• return_ordered: Logical: If TRUE, return levels ordered by count, otherwise return in level order.

• verbosity: Integer: Verbosity level.

Examples

# --- For `Supervised` objects ---
species_cart <- train(iris, hyperparameters = setup_CART())
describe(species_cart)

# --- For `SupervisedRes` objects ---
mod <- train(
  iris,
  hyperparameters = setup_CART(),
  outer_resampling_config = setup_KFold(n_resamples = 3L)
)
describe(mod)

# --- For factors ---
# Small number of levels
describe(iris[["Species"]])

# Large number of levels: show top n by count
x <- factor(sample(letters, 1000, TRUE))
describe(x)
describe(x, 3)
describe(x, 3, return_ordered = FALSE)