fold_change_plot: Fold change plot

View source: R/fold_change_class.R

fold_change_plotR Documentation

Fold change plot

Description

A plot of fold changes calculated for a chosen subset of features. A predefined fold change threshold is indicated by shaded regions.

Usage

fold_change_plot(number_features = 20, orientation = "portrait", ...)

Arguments

number_features

(numeric) The number randomly selected features to plot, or a list of column numbers. The default is 20.

orientation

(character) Plot orientation. Allowed values are limited to the following:

  • "landscape": Features are plotted on the y-axis.

  • "portrait": Features are plotted on the x-axis.

The default is "portrait".

...

Additional slots and values passed to struct_class.

Value

A fold_change_plot object. This object has no output slots. See chart_plot in the struct package to plot this chart object.

Inheritance

A fold_change_plot object inherits the following struct classes:

⁠[fold_change_plot]⁠ >> ⁠[chart]⁠ >> ⁠[struct_class]⁠

Examples

M = fold_change_plot(
      number_features = 10,
      orientation = "portrait")

C = fold_change_plot()

computational-metabolomics/structToolbox documentation built on July 5, 2024, 12:18 p.m.