ScatterCopula: ScatterCopula

View source: R/ModelEvaluationPlots.R

ScatterCopulaR Documentation

ScatterCopula

Description

Dual plot. One on original scale and one using empirical copula data

Usage

ScatterCopula(
  data = NULL,
  x_var = NULL,
  y_var = NULL,
  Marginals = FALSE,
  MarginalType = "density",
  GroupVariable = NULL,
  FacetCol = NULL,
  FacetRow = NULL,
  SizeVar1 = NULL,
  SampleCount = 100000L,
  FitGam = TRUE,
  color = "darkblue",
  point_size = 0.5,
  text_size = 12,
  x_axis_text_angle = 35,
  y_axis_text_angle = 0,
  chart_color = "lightsteelblue1",
  border_color = "darkblue",
  text_color = "darkblue",
  grid_color = "white",
  background_color = "gray95",
  legend_position = "bottom",
  Debug = FALSE
)

Arguments

data

Source data.table

x_var

Numeric variable

y_var

Numeric variable

Marginals

= FALSE,

MarginalType

= 'density',

GroupVariable

Color options

FacetCol

NULL or string

FacetRow

NULL or string

SizeVar1

NULL. Use to size the dots by a variable

SampleCount

Number of randomized rows to utilize. For speedup and memory purposes

FitGam

Add gam fit to scatterplot and copula plot

color

= "darkblue"

point_size

= 0.50

text_size

= 12

x_axis_text_angle

= 35

y_axis_text_angle

= 0

chart_color

= "lightsteelblue1"

border_color

= "darkblue"

text_color

= "darkblue"

grid_color

= "white"

background_color

= "gray95"

legend_position

= "bottom

Debug

= FALSE

Author(s)

Adrian Antico

See Also

Other EDA: AutoWordFreq(), EDA_Histograms(), PlotGUI(), UserBaseEvolution()

Examples

## Not run: 
# Create data
data <- AutoQuant::FakeDataGenerator()

# Build plot
AutoQuant::ScatterCopula(
  data = data,
  x_var = 'Independent_Variable1',
  y_var = 'Independent_Variable2',
  Marginals = FALSE,
  MarginalType = 'density',
  GroupVariable = NULL, #'Factor_1',
  FacetCol = 'Factor_1',
  FacetRow = NULL,
  SizeVar1 = 'Independent_Variable1',
  SampleCount = 100000L,
  FitGam = FALSE,
  color = "darkblue",
  point_size = 0.50,
  text_size = 12,
  x_axis_text_angle = 35,
  y_axis_text_angle = 0,
  chart_color = "lightsteelblue1",
  border_color = "darkblue",
  text_color = "darkblue",
  grid_color = "white",
  background_color = "gray95",
  legend_position = "bottom",
  Debug = FALSE)

## End(Not run)

AdrianAntico/RemixAutoML documentation built on Feb. 3, 2024, 3:32 a.m.