R/plt_regression_line.R

In vbfelix/relper: Miscellaneous Functions for Data Preparation, Cleaning, and Visualization

#' ggplot2: Add a regression line to a scatter plot
#'
#' @description Add a regression line to a ggplot2 scatter plot.
#'
#' @eval arg_value("color","character",default = "'black'", action = "will be the line color")
#' @eval arg_value("linetype","character",default = "'dashed'", action = "will be the line type")
#' @eval arg_value("linewidth","numeric",default = "0.75", action = "will be the line width")
#' @eval arg_value("label","character",default = "'Identity line'", action = "will be the line label")
#'
#' @return A ggplot2 object.
#'
#' @export
#'
#' @examples
#'
#' library(ggplot2)
#'
#' plot <-
#'   ggplot(mtcars,aes(qsec,mpg))+
#'   geom_point()
#'
#' plot
#'
#' plot + plt_regression_line()
#'

plt_regression_line <-
  function(color = "black", linetype = "dashed",linewidth = .75, label = "Regression line"){

    stopifnot(is.character(color), length(color) == 1)

    stopifnot(is.character(linetype), length(linetype) == 1)

    stopifnot(is.numeric(linewidth), length(linewidth) == 1, linewidth > 0)

    list(
      ggplot2::geom_smooth(
        method = "lm",
        se = FALSE,
        formula = "y ~ x",
        mapping = ggplot2::aes(alpha = label),
        linetype = linetype,
        color = color,
        linewidth = linewidth
      ),
      ggplot2::labs(alpha = ""),
      ggplot2::scale_alpha_manual(values = c(1,1))
    )
  }