rt_explore_plot_correlations: returns a heatmap of correlations

View source: R/explore_basics.R

rt_explore_plot_correlationsR Documentation

returns a heatmap of correlations

Description

returns a heatmap of correlations

Usage

rt_explore_plot_correlations(
  dataset,
  corr_threshold = 0,
  p_value_threshold = 1,
  type = "pearson",
  max_missing_column_perc = 0.25,
  base_size = 11
)

Arguments

dataset

dataframe containing numberic columns

corr_threshold

any correlations that are <= 'corr_threshold' will be set to 'NA'. (Default is '0', so all correlations are shown). Helps to reduce noise.

p_value_threshold

any correlations that have a p-value greater than 'p_value_threshold' will be set to 'NA' (Default is '1', so all correlations are shown)

type

type of correlation to perform (Default is 'pearson')

max_missing_column_perc

the max percent of missing values for a column for it to be included. The default is '0.25' (i.e. '25 removed. For example, if you set the value to '0.05' (i.e. '5 values missing would be removed.

base_size

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

Examples


library(ggplot2)
rt_explore_correlations(iris)


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