output_display: Display a grid of plots and tables

View source: R/output_display.R

output_displayR Documentation

Display a grid of plots and tables

Description

This function generates a grid of plots and tables, including a value box, data table, relative GPI plot, and total output plot.

Usage

output_display(
  data = x$data,
  time = time,
  date_format = c("%d/%m/%Y"),
  name = theatre,
  relative_gpi_val = emissions,
  gti_by = c("default", "month", "year"),
  plot_val = carbon_price_credit,
  plot_by = "default",
  pdf = TRUE
)

Arguments

data

The data frame containing the data.

time

The variable representing the time dimension.

date_format

The date format for the time variable (optional, default: "%d/%m/%Y").

name

The variable representing the grouping variable.

relative_gpi_val

The variable representing the relative GPI (Growth to Previous Index) value.

gti_by

The grouping type for calculating the GTI ("default", "month", "year").

plot_val

The variable to plot in the total output plot.

plot_by

The grouping type for the total output plot ("default", "month", "year").

pdf

Whether to export the plots to a PDF file (default: TRUE).

Details

The function utilises other auxiliary functions such as relative_gti() and total_output().

Value

A grid of plots and tables showing the value box, data table, relative GPI plot, and total output plot.


carbonr documentation built on Oct. 17, 2024, 1:06 a.m.