dot-check_input_plot_args: Internal checks on common plot input arguments

In familiar: End-to-End Automated Machine Learning and Model Evaluation

Internal checks on common plot input arguments

Description

Internal checks on common plot input arguments

Usage

.check_input_plot_args(
  x_range = waiver(),
  y_range = waiver(),
  x_n_breaks = waiver(),
  y_n_breaks = waiver(),
  x_breaks = waiver(),
  y_breaks = waiver(),
  conf_int = waiver(),
  conf_int_alpha = waiver(),
  conf_int_style = waiver(),
  conf_int_default = c("step", "ribbon", "none"),
  facet_wrap_cols = waiver(),
  x_label = waiver(),
  y_label = waiver(),
  x_label_shared = waiver(),
  y_label_shared = waiver(),
  rotate_x_tick_labels = waiver(),
  rotate_y_tick_labels = waiver(),
  legend_label = waiver(),
  combine_legend = waiver(),
  plot_title = waiver(),
  plot_sub_title = waiver(),
  caption = waiver()
)

Arguments

x_range	(optional) Value range for the x-axis.
y_range	(optional) Value range for the y-axis.
x_n_breaks	(optional) Number of breaks to show on the x-axis of the plot. x_n_breaks is used to determine the x_breaks argument in case it is unset.
y_n_breaks	(optional) Number of breaks to show on the y-axis of the plot. y_n_breaks is used to determine the y_breaks argument in case it is unset.
x_breaks	(optional) Break points on the x-axis of the plot.
y_breaks	(optional) Break points on the y-axis of the plot.
conf_int	(optional)
conf_int_alpha	(optional) Alpha value to determine transparency of confidence intervals or, alternatively, other plot elements with which the confidence interval overlaps. Only values between 0.0 (fully transparent) and 1.0 (fully opaque) are allowed.
conf_int_style	(optional) Confidence interval style. See details for allowed styles.
conf_int_default	Sets the default options for the confidence interval.
facet_wrap_cols	(optional) Number of columns to generate when facet wrapping. If NULL, a facet grid is produced instead.
x_label	(optional) Label to provide to the x-axis. If NULL, no label is shown.
y_label	(optional) Label to provide to the y-axis. If NULL, no label is shown.
x_label_shared	(optional) Sharing of x-axis labels between facets. One of three values: overall: A single label is placed at the bottom of the figure. Tick text (but not the ticks themselves) is removed for all but the bottom facet plot(s). column: A label is placed at the bottom of each column. Tick text (but not the ticks themselves) is removed for all but the bottom facet plot(s). individual: A label is placed below each facet plot. Tick text is kept.
y_label_shared	(optional) Sharing of y-axis labels between facets. One of three values: overall: A single label is placed to the left of the figure. Tick text (but not the ticks themselves) is removed for all but the left-most facet plot(s). row: A label is placed to the left of each row. Tick text (but not the ticks themselves) is removed for all but the left-most facet plot(s). individual: A label is placed below each facet plot. Tick text is kept.
rotate_x_tick_labels	(optional) Rotate tick labels on the x-axis by 90 degrees. Defaults to TRUE. Rotation of x-axis tick labels may also be controlled through the ggtheme. In this case, FALSE should be provided explicitly.
rotate_y_tick_labels	(optional) Rotate tick labels on the y-axis by 45 degrees.
legend_label	(optional) Label to provide to the legend. If NULL, the legend will not have a name.
combine_legend	(optional) Flag to indicate whether the same legend is to be shared by multiple aesthetics, such as those specified by color_by and linetype_by arguments.
plot_title	(optional) Label to provide as figure title. If NULL, no title is shown.
plot_sub_title	(optional) Label to provide as figure subtitle. If NULL, no subtitle is shown.
caption	(optional) Label to provide as figure caption. If NULL, no caption is shown.

familiar documentation built on Sept. 30, 2024, 9:18 a.m.