vl_impute — vl_impute • vegabrite

Add ImputeTransform to a vega-lite spec.

Usage

vl_impute(
  spec,
  impute = NULL,
  key = NULL,
  frame = NULL,
  groupby = NULL,
  keyvals = NULL,
  method = NULL,
  value = NULL,
  .object = NULL
)

Arguments

spec

An input vega-lite spec

impute

The data field for which the missing values should be imputed.

key

A key field that uniquely identifies data objects within a group. Missing key values (those occurring in the data but not in the current group) will be imputed.

frame

A frame specification as a two-element array used to control the window over which the specified method is applied. The array entries should either be a number indicating the offset from the current data object, or null to indicate unbounded rows preceding or following the current data object. For example, the value [-5, 5] indicates that the window should include five objects preceding and five objects following the current object.

Default value:: [null, null] indicating that the window includes all objects.

groupby

An optional array of fields by which to group the values. Imputation will then be performed on a per-group basis.

keyvals

Defines the key values that should be considered for imputation. An array of key values or an object defining a number sequence.

If provided, this will be used in addition to the key values observed within the input data. If not provided, the values will be derived from all unique values of the key field. For impute in encoding, the key field is the x-field if the y-field is imputed, or vice versa.

If there is no impute grouping, this property must be specified.

method

The imputation method to use for the field value of imputed data objects. One of "value", "mean", "median", "max" or "min".

Default value: "value"

value

The field value to use when the imputation method is "value".

.object

Directly input an object, rather than creating one via the other arguments. Should not be used in conjunction with the other arguments other than spec. Objects can be of type: ImputeTransform

Value

A modified Vega-Lite Spec