PlotSPLS3DScoreImg: Plot sPLS-DA 3D score plot

In xia-lab/MetaboAnalystR: An R Package for Comprehensive Analysis of Metabolomics Data

Plot sPLS-DA 3D score plot

Description

This function creates two 3D sPLS-DA score plots, the first is static for Analysis Report purposes, as well as an interactive 3D plot using the plotly R package. The 3D score plot is saved in the created mSetObj (mSetObj$imgSet$splsda.3d). To view the score plot, if the name of your mSetObj is mSet, enter "mSet$imgSet$splsda.3d" to view the interactive score plot.

This function creates two 3D sPLS-DA score plots, the first is static for Analysis Report purposes, as well as an interactive 3D plot using the plotly R package. The 3D score plot is saved in the created mSetObj (mSetObj$imgSet$splsda.3d). To view the score plot, if the name of your mSetObj is mSet, enter "mSet$imgSet$splsda.3d" to view the interactive score plot.

Usage

PlotSPLS3DScoreImg(
  mSetObj = NA,
  imgName,
  format = "png",
  dpi = 72,
  width = NA,
  inx1,
  inx2,
  inx3,
  angl
)

PlotSPLS3DScoreImg(
  mSetObj = NA,
  imgName,
  format = "png",
  dpi = 72,
  width = NA,
  inx1,
  inx2,
  inx3,
  angl
)

Arguments

mSetObj	Input name of the created mSet Object
imgName	Input a name for the plot
format	Select the image format, "png", or "pdf".
dpi	Input the dpi. If the image format is "pdf", users need not define the dpi. For "png" images, the default dpi is 72. It is suggested that for high-resolution images, select a dpi of 300.
width	Input the width, there are 2 default widths, the first, width = NULL, is 10.5. The second default is width = 0, where the width is 7.2. Otherwise users can input their own width.
inx1	Numeric, indicate the number of the principal component for the x-axis of the loading plot.
inx2	Numeric, indicate the number of the principal component for the y-axis of the loading plot.
inx3	Numeric, indicate the number of the principal component for the z-axis of the loading plot.
angl	Input the angle

Author(s)

Jeff [e-mail] McGill University, Canada License: GNU GPL (>= 2)

xia-lab/MetaboAnalystR documentation built on Dec. 23, 2024, 3:44 p.m.