feature_boxplot {structToolbox}R Documentation

Feature boxplot

Description

A boxplot to visualise the distribution of values within a feature.

Usage

feature_boxplot(
  label_outliers = TRUE,
  feature_to_plot,
  factor_name,
  show_counts = TRUE,
  ...
)

Arguments

label_outliers

(logical) Label outliers. Allowed values are limited to the following:

  • "TRUE": The index for outlier samples is included on the plot.

  • "FALSE": No labels are displayed.

The default is TRUE.

feature_to_plot

(character, numeric, integer) The column name of the plotted feature.

factor_name

(character) The name of a sample-meta column to use.

show_counts

(logical) Show counts. Allowed values are limited to the following:

  • "TRUE": The number of samples for each box is displayed.

  • "FALSE": The number of samples for each box is not displayed.

The default is TRUE.

...

Additional slots and values passed to struct_class.

Value

A feature_boxplot object.

Examples

D = MTBLS79_DatasetExperiment
C = feature_boxplot(factor_name='Species',feature_to_plot='Petal.Width')
chart_plot(C,D)

[Package structToolbox version 1.2.0 Index]