get_desc_df.grid_partition: Get descriptive data.frame

View source: R/grid_partition.R

get_desc_df.grid_partitionR Documentation

Get descriptive data.frame

Description

Get information for each cell

Usage

## S3 method for class 'grid_partition'
get_desc_df(
  obj,
  cont_bounds_inf = TRUE,
  do_str = FALSE,
  drop_unsplit = FALSE,
  digits = NULL,
  unsplit_cat_star = TRUE,
  ...
)

Arguments

obj

partition object

cont_bounds_inf

Should "Inf" be used for continuous bounds (otherwise the bounds from X_range)

do_str

If True, use a string like "(a, b]", otherwise have two separate columns with a and b

drop_unsplit

If True, drop columns for variables overwhich the partition did not split

digits

digits Option (default is NULL)

unsplit_cat_star

Should unsplit categorical variables be listed as "*", otherwise all factor labels will be used.

...

Additional arguments.

Value

data.frame with columns: partitioning columns


microsoft/CausalGrid documentation built on Aug. 25, 2022, 9:30 a.m.