R/CreateFittedAgainstResidualsPlot.R

In itslwg/regone: regone

#' CreateFittedAgainstResidualspLot
#'
#' Creates and returns a plot with fitted against residuals plot.
#' @param data data.frame object. Data as prepared in "RunProject.R". Regressor values, predicted response, and residuals. No default.
#' @param dir Character vector of lenght 1. Directory in which to store the plot. Ignored if save.plot is FALSE. Defaults to "./"
#' @param save.plot Logical vector of length 1. If TRUE then the plot is saved to disk. Defaults to TRUE
#' @importFrom magrittr "%>%"
#' @export
CreateFittedAgainstResidualsPlot <- function(data, dir = "./", save.plot = TRUE) {
    ## Error handling
    if (!all(c("r.student", "predicted") %in% names(data)))
        stop("Columns r.student and predicted representing the externally studentized residuals and the fitted values, respectively, must be in plot.data.")
    plt <- data %>%
        ggplot2::ggplot(ggplot2::aes(x = predicted, y = r.student)) +
        ggplot2::geom_point() +
        ggplot2::geom_hline(yintercept = 0, linetype = "dashed") +
        ggplot2::xlab("Fitted values") +
        ggplot2::ylab("R-student residuals")
    if (save.plot)
        suppressMessages({
            ggplot2::ggsave(paste0(dir, "far.png"), plt, width = 5, height = 5)  
        })
    return(plt)
}