R/moving_filter_plot_r.R

In maxgav13/GMisc: Miscellaneous Functions for Geology (and its areas)

#' @title Moving (weighted) average filter plot (residual)
#' @description Plots the residual results of a moving (weighted) average filter routine.
#' @param x The result of using the \code{moving_avg_filter()} or \code{moving_wt_filter()} functions
#' @param xlab The label for the x-axis
#' @param ylab The label for the y-axis
#' @param filterlab The label for the legend
#' @param plotk A string for choosing what to plot (Default is "all")
#' @export
#' @return ggplot and plotly objects with the residual data
#' @import ggplot2
#' @examples
#' data(nautilus)
#' k = c(3, 5, 7, 9)
#' filt = moving_avg_filter(nautilus$x, nautilus$y, k)
#' moving_filter_plot_r(filt)
#' moving_filter_plot_r(filt, plotk = c("k_3", "k_9")) # plots residuals for filters of window 3 and 9
#'
moving_filter_plot_r = function(x, xlab = "X", ylab = "Residual data",filterlab = "Filter", plotk = "all") {

  if (any(plotk == "all")) {
    df = x$Residual
  } else {
    zz = plotk
    df = x$Residual %>% dplyr::select(c("x",zz))
  }

  df = tidyr::pivot_longer(df, cols = -x, names_to = 'filtro', values_to = 'y_val')
  df$filtro = factor(df$filtro, levels = unique(df$filtro))

  r = ggplot(df, aes(x = x, y = .data$y_val,
                     group = .data$filtro, col = .data$filtro)) +
    geom_line(size = 0.5) +
    labs(x = xlab, y = ylab, col = filterlab) +
    theme_bw()

  p = plotly::ggplotly(r, dynamicTicks = T)

  return(list(GGPLOT=r, PLOTLY=p))
}