R/lpirfs_obj-methods-base.R

In AdaemmerP/lpirfs: Local Projections Impulse Response Functions

#' Base methods for lpirfs_obj objects
#' @name lpirfs_obj-methods-base

NULL

#########################  lpirfs_lin_obj #############################################

#' @name plot.lpirfs_lin_obj
#' @title Base print() function to plot all impulse responses from linear lpirfs object
#' @export
#' @param x An object of type 'lpirfs_lin_obj
#' @param ... Additional arguments to be consistent with S3 print() function
#' @importFrom gridExtra marrangeGrob
#' @importFrom ggplot2 ggplotGrob
#' @method plot lpirfs_lin_obj

plot.lpirfs_lin_obj <- function(x, ...){

  # Extract number for column names
  nr_cols       <- x$specs$endog

  lin_plots     <- plot_lin(x)

  # Save plots based on states
  lin_plots_all <- sapply(lin_plots, ggplotGrob)

  # Show all plots
  gridExtra::marrangeGrob(lin_plots_all, nrow = nr_cols, ncol = nr_cols, top = NULL)


}

#' @name summary.lpirfs_lin_obj
#' @title Summary for linear lpirfs object
#' @export
#' @param object An object of type 'lpirfs_lin_obj'
#' @param ... Additional arguments to be consistent with S3 print() function
#' @method summary lpirfs_lin_obj
summary.lpirfs_lin_obj <- function(object, ...){

   object[[4]]

}


#########################  lpirfs_nl_obj #############################################


#' @name plot.lpirfs_nl_obj
#' @title Base print() function to plot all impulse responses from nonlinear lpirfs object
#' @export
#' @param x An object of type 'lpirfs_nl_obj'
#' @param ... Additional arguments to be consistent with S3 print() function
#' @importFrom gridExtra marrangeGrob
#' @importFrom ggplot2 ggplotGrob
#' @method plot lpirfs_nl_obj

plot.lpirfs_nl_obj <- function(x, ...){


  # Make and save all plots
  nl_plots <- plot_nl(x)

  # Number of columns
  nr_cols       <- x$specs$endog

  # Save plots based on states
  s1_plots <- sapply(nl_plots$gg_s1, ggplotGrob)
  s2_plots <- sapply(nl_plots$gg_s2, ggplotGrob)

  # Show all plots
  result_1 <- marrangeGrob(s1_plots, nrow = nr_cols, ncol = nr_cols, top = NULL)
  result_2 <- marrangeGrob(s2_plots, nrow = nr_cols, ncol = nr_cols, top = NULL)

  list(result_1, result_2)


}

#' @name summary.lpirfs_nl_obj
#' @title Summary for nonlinear lpirfs object
#' @export
#' @param object An object of type 'lpirfs_nl_obj'
#' @param ... Additional arguments to be consistent with S3 print() function
#' @method summary lpirfs_nl_obj
summary.lpirfs_nl_obj <- function(object, ...){

  object[[9]]


}


######################### lpirfs_lin_iv_obj ############################################

#' @name plot.lpirfs_lin_iv_obj
#' @title Base print() function to plot all impulse responses from linear lpirfs object
#' @export
#' @param x An object of type 'lpirfs_lin_obj
#' @param ... Additional arguments to be consistent with S3 print() function
#' @importFrom gridExtra marrangeGrob
#' @importFrom ggplot2 ggplotGrob
#' @method plot lpirfs_lin_iv_obj

plot.lpirfs_lin_iv_obj <- function(x, ...){

  # Extract number for column names
  nr_cols       <- x$specs$endog

  lin_plots     <- plot_lin(x)

  # Save plots based on states
  lin_plots_all <- sapply(lin_plots, ggplotGrob)

  # Show all plots
  gridExtra::marrangeGrob(lin_plots_all, nrow = nr_cols, ncol = 1, top = NULL)


}


#' @name summary.lpirfs_lin_iv_obj
#' @title Summary for nonlinear lpirfs object
#' @export
#' @param object An object of type 'lpirfs_lin_iv_obj'
#' @param ... Additional arguments to be consistent with S3 print() function
#' @method summary lpirfs_lin_iv_obj
summary.lpirfs_lin_iv_obj <- function(object, ...){

  object[[4]]


}


######################### lpirfs_nl_iv_obj ############################################


#' @name plot.lpirfs_nl_iv_obj
#' @title Base print() function to plot all impulse responses from linear lpirfs object
#' @export
#' @param x An object of type 'lpirfs_nl_iv_obj'
#' @param ... Additional arguments to be consistent with S3 print() function
#' @importFrom gridExtra marrangeGrob
#' @importFrom ggplot2 ggplotGrob
#' @method plot lpirfs_nl_iv_obj

plot.lpirfs_nl_iv_obj <- function(x, ...){

  # Make and save all plots
  nl_plots      <- plot_nl(x)

  # Number of columns
  nr_cols       <- x$specs$endog

  # Save plots based on states
  s1_plots <- sapply(nl_plots$gg_s1, ggplotGrob)
  s2_plots <- sapply(nl_plots$gg_s2, ggplotGrob)

  # Show all plots
  result_1 <- marrangeGrob(s1_plots, nrow = nr_cols, ncol = 1, top = NULL)
  result_2 <- marrangeGrob(s2_plots, nrow = nr_cols, ncol = 1, top = NULL)

  list(result_1, result_2)



}



#' @name summary.lpirfs_nl_iv_obj
#' @title Summary for nonlinear lpirfs object
#' @export
#' @param object An object of type 'lpirfs_nl_iv_obj'
#' @param ... Additional arguments to be consistent with S3 print() function
#' @method summary lpirfs_nl_iv_obj
summary.lpirfs_nl_iv_obj <- function(object, ...){

  object[[7]]


}



######################### lpirfs_lin_panel_obj ############################################



#' @name plot.lpirfs_lin_panel_obj
#' @title Base print() function to plot all impulse responses from linear lpirfs object
#' @export
#' @param x An object of type 'lpirfs_lin_panel_obj'
#' @param ... Additional arguments to be consistent with S3 print() function
#' @importFrom gridExtra marrangeGrob
#' @importFrom ggplot2 ggplotGrob
#' @importFrom graphics plot
#' @method plot lpirfs_lin_panel_obj

plot.lpirfs_lin_panel_obj <- function(x, ...){

  # Extract number for column names
  nr_cols            <- x$specs$endog

  plot_lin_panel     <- plot_lin(x)

  plot(plot_lin_panel[[1]])


}


#' @name summary.lpirfs_lin_panel_obj
#' @title Summary for nonlinear lpirfs object
#' @export
#' @param object An object of type 'lpirfs_lin_panel_obj'
#' @param ... Additional arguments to be consistent with S3 print() function
#' @method summary lpirfs_lin_panel_obj
summary.lpirfs_lin_panel_obj <- function(object, ...){

  object[[7]]


}



######################### lpirfs_nl_panel_obj ############################################



#' @name plot.lpirfs_nl_panel_obj
#' @title Base print() function to plot all impulse responses from linear lpirfs object
#' @export
#' @param x An object of type 'lpirfs_lin_panel_obj'
#' @param ... Additional arguments to be consistent with S3 print() function
#' @importFrom gridExtra marrangeGrob
#' @importFrom ggplot2 ggplotGrob
#' @method plot lpirfs_nl_panel_obj

plot.lpirfs_nl_panel_obj <- function(x, ...){

  # Extract number for column names
  nr_cols            <- x$specs$endog

  plot_nl_panel     <- plot_nl(x)


  combine_plots <- list(plot_nl_panel$gg_s1[[1]], plot_nl_panel$gg_s2[[1]])
  marrangeGrob(combine_plots, nrow = 1, ncol = 2, top = NULL)



}


#' @name summary.lpirfs_nl_panel_obj
#' @title Summary for nonlinear lpirfs object
#' @export
#' @param object An object of type 'lpirfs_lin_panel_obj'
#' @param ... Additional arguments to be consistent with S3 print() function
#' @method summary lpirfs_nl_panel_obj
summary.lpirfs_nl_panel_obj <- function(object, ...){

  object[[7]]


}