rt_explore_correlations: returns a matrix containing of correlations

View source: R/explore_basics.R

rt_explore_correlationsR Documentation

returns a matrix containing of correlations

Description

returns a matrix containing of correlations

Usage

rt_explore_correlations(
  dataset,
  corr_threshold = 0,
  p_value_threshold = 1,
  max_missing_column_perc = 0.25,
  type = "pearson"
)

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)

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.

type

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

Examples


library(ggplot2)
rt_explore_correlations(iris)


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