R/plot_qq.lm.R

In lmvar: Linear Regression with Non-Constant Variances

#' @title QQ-plot for an object of class 'lm'
#'
#' @description Function produces QQ-plots for an object of class 'lm' and, optionally, for another object of class 'lm' or 'lmvar'.
#'
#' @param object_1 Object of class 'lm'
#' @param object_2 Object of class 'lm' or class 'lmvar'
#' @param ... for compatibility with \code{\link{plot_qq}} generic.
#'
#' @details If \code{object_2} is specified, a QQ-plot for \code{object_1} and one for \code{object_2} will be
#' combined in the same plot.
#'
#' All inputs of class 'lm' must contain the response vector \eqn{y}. I.e., one must run \code{\link[stats]{lm}}
#' with argument \code{y = TRUE}.
#'
#' @seealso \code{\link{plot_qq}}
#'
#' @export
#'
#' @example R/examples/plot_qq.lm_examples.R
#'


plot_qq.lm <- function( object_1, object_2 = NULL, ...){

  name_1 = deparse(substitute(object_1))
  name_2 = deparse(substitute(object_2))

  plot_qq_lmlike( object_1, object_2, name_1, name_2)
}