band_data: Bands Variables in Dataset

In Nanoputian628/nano: Data Visualisation and Model Selection

Bands Variables in Dataset

Description

Creates a custom bands for variables in dataset.

Usage

band_data(
  data,
  intervals,
  buckets = NULL,
  na_bucket,
  unmatched_bucket,
  trunc_left = FALSE,
  trunc_right = FALSE,
  include_left = TRUE
)

Arguments

data	dataset to be analysed.
intervals	a list defining the bands for each of the variables.
buckets	a list defining the names of the bands for each of the variables.
na_bucket	a character or a list defining the bucket name for entries with NA.
unmatched_bucket	a character or a list defining the bucket name for unmatched entries.
trunc_left	a logical specifying whether the band to -Inf should be created.
trunc_right	a logical specifying whether the band to Inf should be created.
include_left	a logical specifying if should include the left or right endpoint for each interval.

Details

The intervals parameter must be entered as a list with names matching the column names in data. The elements of the list can be specified in two ways.

It can be specified as a vector of non-decreasing numbers (note the same number can be repeated, this will correspond to a band of a single point). The intervals will then be derived from these vectors of numbers in combination with the trunc_left, trunc_right and include_left parameters. For example, the vector c(1, 3, 3, 6) with the default parameters will produce the intervals (-Inf, 1), [1, 3), [3, 3), [3, 6), [6, Inf). It can also be directly specified as a character vector of the desired intervals. Note if this option is taken, the trunc_left, trunc_right and include_left parameters become redundant.

The na_bucket and unmatched_bucket parameters can be specified either a single character or as a list of the desired bucket names for each variable. If specified as a single character, then this will be applied to all variables. If the buckets parameter is not specified, then the bucket names will be set equal to the interval names. ## Not run: if(interactive()){ data(property_prices) band_data(data = property_prices, intervals = list(crime_rate = seq(0.1, 1, 0.1), # example as numeric vector income = c("[0,500)", "[500, 1000)") # example as character vector ) ) } ## End(Not run)

Value

a data.table with the original variables and new banded variables with the suffix "_bnd".

Nanoputian628/nano documentation built on Oct. 30, 2023, 3:28 p.m.