plot_y_estimates {BKTR}R Documentation

Plot Y Estimates

Description

Plot y estimates vs observed y values.

Usage

plot_y_estimates(
  bktr_reg,
  show_figure = TRUE,
  fig_width = 5,
  fig_height = 5,
  fig_resolution = 200,
  fig_title = "y estimates vs observed y values"
)

Arguments

bktr_reg

BKTRRegressor: BKTRRegressor object.

show_figure

Boolean: Whether to show the figure. Defaults to True.

fig_width

Numeric: Figure width when figure is shown. Defaults to 5.

fig_height

Numeric: Figure height when figure is shown. Defaults to 5.

fig_resolution

Numeric: Figure resolution PPI when figure is shown. Defaults to 200.

fig_title

String or NULL: Figure title if provided. Defaults to 'y estimates vs observed y values'

Value

ggplot or NULL: ggplot object or NULL if show_figure is set to FALSE.

Examples


# Launch MCMC sampling on a light version of the BIXI dataset
bixi_data <- BixiData$new(is_light = TRUE)
bktr_regressor <- BKTRRegressor$new(
  data_df <- bixi_data$data_df,
  spatial_positions_df = bixi_data$spatial_positions_df,
  temporal_positions_df = bixi_data$temporal_positions_df,
  burn_in_iter = 5, sampling_iter = 10) # For example only (too few iterations)
bktr_regressor$mcmc_sampling()

# Plot Y estimates vs observed y values
plot_y_estimates(bktr_regressor)


[Package BKTR version 0.1.1 Index]