hai_density_hist_plotR Documentation

Density Histogram Plot

Description

this will produce a ggplot2 or plotly histogram plot of the density information provided from the hai_get_density_data_tbl function.

Usage

hai_density_hist_plot(
  .data,
  .dist_name_col = distribution,
  .value_col = dist_data,
  .alpha = 0.382,
  .interactive = FALSE
)

Arguments

.data

The data that is produced from using hai_get_density_data_tbl

.dist_name_col

The column that has the distribution name, should be distribution and that is set as the default.

.value_col

The column that contains the x values that comes from the hai_get_density_data_tbl function.

.alpha

The alpha parameter for ggplot

.interactive

This is a Boolean fo TRUE/FALSE and is defaulted to FALSE. TRUE will produce a plotly plot.

Details

This will produce a histogram of the density information that is produced from the function hai_get_density_data_tbl. It will look for an attribute from the .data param to ensure the function was used.

Value

A plot, either ggplot2 or plotly

Author(s)

Steven P. Sanderson II, MPH

See Also

Other Distribution Plots: hai_density_plot(), hai_density_qq_plot()

Examples

library(dplyr)

df <- hai_scale_zero_one_vec(.x = mtcars$mpg) %>%
  hai_distribution_comparison_tbl()

dist_data_tbl <- hai_get_dist_data_tbl(df)

hai_density_hist_plot(
  .data = dist_data_tbl,
  .dist_name_col = distribution,
  .value_col = dist_data,
  .alpha = 0.5,
  .interactive = FALSE
)