pls_vip_plot: PLSDA VIP plot

View source: R/PLSDA_charts.R

pls_vip_plotR Documentation

PLSDA VIP plot

Description

A plot of the Variable Importance for Projection (VIP) scores for a PLSDA model.

Usage

pls_vip_plot(threshold = 1, ycol = 1, ...)

Arguments

threshold

(numeric, integer) The threshold for indicating significant features. The default is 1.

ycol

(character, numeric, integer) The column of the Y block to be plotted. The default is 1.

...

Additional slots and values passed to struct_class.

Details

This object makes use of functionality from the following packages:

  • pls

  • ggplot2

Value

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

Inheritance

A pls_vip_plot object inherits the following struct classes:

⁠[pls_vip_plot]⁠ >> ⁠[chart]⁠ >> ⁠[stato]⁠ >> ⁠[struct_class]⁠

References

Liland K, Mevik B, Wehrens R (2023). pls: Partial Least Squares and Principal Component Regression. R package version 2.8-3, https://CRAN.R-project.org/package=pls.

Wickham H (2016). ggplot2: Elegant Graphics for Data Analysis. Springer-Verlag New York. ISBN 978-3-319-24277-4, https://ggplot2.tidyverse.org.

Examples

M = pls_vip_plot(
      threshold = 1,
      ycol = 1)

D = iris_DatasetExperiment()
M = mean_centre()+PLSDA(factor_name='Species')
M = model_apply(M,D)

C = pls_vip_plot(ycol='setosa')
chart_plot(C,M[2])

computational-metabolomics/structtoolbox documentation built on Feb. 9, 2024, 8:19 a.m.