SaveDescrStats: Saves all the components of the output of DescriptiveStats()...

View source: R/SaveDescrStats.R

SaveDescrStatsR Documentation

Saves all the components of the output of DescriptiveStats() to a specified folder

Description

Gets the output of DescriptiveStats() and no matter what options were selected, saves in a specified folder all the valid Statistics Saving the plots, one might also choose different sizes for the Categorical plots, Numerical ones, and Timeseries as well.

Usage

SaveDescrStats(
  DescriptiveStatsVar,
  path_stats,
  NumWidth = 1300,
  NumHeight = 800,
  CatWidth = 1300,
  CatHeight = 800,
  TimeProgressionWidth = NULL,
  TimeProgressionHeight = NULL,
  TimeSeriesWidth = NULL,
  TimeSeriesHeight = NULL,
  CorrelationsWidth = NULL,
  CorrelationsHeight = NULL
)

Arguments

DescriptiveStatsVar

A list. The output of DescriptiveStats() on a dataset

path_stats

A string. The relative or full path of a folder (existing or to be created) where all the matrices and plots will be saved on

NumWidth

An Integer. Width (in pixels) for Numerical Variables' plots

NumHeight

An Integer. Height (in pixels) for Numerical Variables' plots

CatWidth

An Integer. Width (in pixels) for Categorical Variables' plots

CatHeight

An Integer. Height (in pixels) for Categorical Variables' plots

TimeProgressionWidth

An Integer. Width (in pixels) for the Time Progression plot

TimeProgressionHeight

An Integer. Height (in pixels) for the Time Progression plot

TimeSeriesWidth

An Integer. Width (in pixels) for the Timeseries plot

TimeSeriesHeight

An Integer. Height (in pixels) for the Timeseries plot

CorrelationsWidth

An Integer. Width (in pixels) for the Correlation plots

CorrelationsHeight

An Integer. Height (in pixels) for the Correlation plots

Examples

DS <- mtcars %>% mutate(vs = as.factor(vs), am = as.factor(am), gear = as.factor(gear), carb = as.factor(carb)) %>% as_tibble()

#Creating the Variable which holds all the Matrices and Plots
MTCarsStats <- DS %>% DescriptiveStats(CalculateGraphs = TRUE, DependentVar = "mpg", IsTimeSeries = TRUE, GroupBy = "gear", CorrVarOrder = "PCA")

#Saving everything to a folder on our Hard Drive
MTCarsStats %>% SaveDescrStats("MTCarsFolder")

N1h1l1sT/DescriptiveStatsR documentation built on Dec. 9, 2022, 3:57 a.m.