Skip to contents

Draw a standard residual plot

Source: R/zzz_auto_visual_inference.R
AUTO_VI-cash-plot_resid.Rd

This function draws a standard residual plot.

Usage

AUTO_VI$plot_resid(
  data = self$get_fitted_and_resid(),
  theme = ggplot2::theme_light(base_size = 11/5),
  alpha = 1,
  size = 0.5,
  stroke = 0.5,
  remove_axis = TRUE,
  remove_legend = TRUE,
  remove_grid_line = TRUE,
  add_zero_line = TRUE
)

Arguments

data

Data frame. A data frame containing variables .resid and .fitted. See also AUTO_VI$get_fitted_and_resid().

theme

ggtheme. A ggplot theme object. See also ggplot2::theme_light().

alpha

Numeric. Alpha of dot. Value between 0 and 1.

size

Numeric. Size of dot. Value between 0 and 1.

stroke

Numeric. Stroke of dot. Value between 0 and 1.

remove_axis

Boolean. Whether or not to remove the axis.

remove_legend

Boolean. Whether or not to remove the legend.

remove_grid_line

Boolean. Whether or not to remove the grid lines.

add_zero_line

Boolean. Whether or not to add a zero horizontal line.

Value

A ggplot.

Examples


my_vi <- auto_vi(fitted_model = lm(speed ~ dist, data = cars))
my_vi$plot_resid()