Learn R Programming

api2lm (version 0.2)

arg_check_residual_plot_lm: Check arguments of residual_plot.lm

Description

Check arguments of residual_plot.lm

Usage

arg_check_residual_plot_lm(
  rtype,
  xaxis,
  id_n,
  smooth,
  add_reference,
  add_smooth,
  text_arglist,
  abline_arglist,
  smooth_arglist,
  lines_arglist,
  extendrange_f
)

Arguments

rtype

The residual type to plot. The default is "ordinary". The other options are "standardized", "studentized", "loo", "jackknife", "deleted", "internally studentized", "externally studentized".

xaxis

The variable to use on the x-axis of the plot(s). The default is "fitted" to use fitted values. The other option is "predictors".

id_n

The number of points to identify with labels. The default is 3.

smooth

A function with a formula argument to smooth the desired plot. The default function is loess.

add_reference

A logical value indicating whether a reference line should be added. The default is TRUE.

add_smooth

A logical value indicating whether a smooth should be added to each plot produced. The default is TRUE.

text_arglist

Additional arguments passed to the text function, which is used to display the points that are identified.

abline_arglist

A named list specifying additional arguments passed to the abline function for the horizontal reference line added to the plot.

smooth_arglist

A named list specifying additional arguments passed to the function provided in the smooth argument.

lines_arglist

A named list specifying additional arguments passed to the lines function for plotting the result of applying the smooth function.

extendrange_f

Positive number(s) specifying the fraction by which the range of the residuals should be extended using the extendrange function. If longer than one, f[1] is used on the left and f[2] on the right.