Generate the OrthPLS Summary Plot
Utilises the mjrO2plsSummaryPlot function written by Mattias Rantalainen.
If loadings plots are generated (with plot_type = 'loadings' or 'all'),
Statistics about the association between X and Y are calculated and
returned in figure.output.association_XY.
figure = csm_plot_orth_pls( csm_orth_pls_model );
figure = csm_plot_orth_pls( csm_orth_pls_model, 'plot_type', plot_type, );
| Variable | Type | Default Value | Description |
|---|---|---|---|
| *csm_orth_pls_model | csm_orth_pls | None | OrthPLS model created by csm_orth_pls. |
| plot_type | str | 'all' | 'all','scores','loadings', 'stats','perm' |
| sample_ids | cell | sample_ids from csm_orth_pls spectra input | Sample Labels for plotting |
| name | str | date | Name to annotate the figure with |
| save_dir | str | none | Save directory |
| Variable | Type | Description |
|---|---|---|
| figure | obj | csm_figure_handle with some stored inputs, the handle and metadata. |
| figure.output.association_XY.cor | m*n | Correlation matrix of X and Y. |
| figure.output.association_XY.cov | m*n | Covariance matrix of X and Y. |
| figure.output.association_XY.cor_p_value | 1*1 | P Value of the correlation between X and Y. |
Copyright Imperial College London 2019