rt_explore_plot_numeric_heatmap: returns a heat map with histogram on top/side showing...

View source: R/explore_basics.R

rt_explore_plot_numeric_heatmapR Documentation

returns a heat map with histogram on top/side showing distribution of both features.

Description

returns a heat map with histogram on top/side showing distribution of both features.

Usage

rt_explore_plot_numeric_heatmap(
  dataset,
  x_variable,
  y_variable,
  n_cuts = 6,
  x_cut_sequence = NULL,
  y_cut_sequence = NULL,
  sum_by_variable = NULL,
  count_distinct_variable = NULL,
  multi_value_delimiter = NULL,
  base_size = 11
)

Arguments

dataset

dataframe containing numberic columns

x_variable

the numeric variable to show on the x-axis

y_variable

the numeric variable to show on the y-axis

n_cuts

the number of cut points (will generate 'n_cuts'-1 groups)

x_cut_sequence

a vector of cut points; if not NULL, overrides 'n_cuts' for the x variable

y_cut_sequence

a vector of cut points; if not NULL, overrides 'n_cuts' for the y variable

sum_by_variable

the numeric variable to sum

count_distinct_variable

when aggregating, rather than counting the total number of records, count distinct occurances of this variabled (cannot be used with 'sum_by_variable')

multi_value_delimiter

(currently not implemented) if the variable contains multiple values (e.g. "A", "A, B", ...) then setting this variable to the delimiter will cause the function to count seperate values

base_size

uses ggplot's base_size parameter for controling the size of the text


shane-kercheval/rtools documentation built on July 7, 2022, 8:31 a.m.