| 883f7f27 |
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/PCA_plotfcns.R
|
| 40be1b5c |
\name{pca_dstat_plot}
\alias{pca_dstat_plot}
|
| d0f81a51 |
\title{d-statistic plot}
|
| 8db793ae |
\usage{
|
| 40be1b5c |
pca_dstat_plot(number_components = 2, alpha = 0.05, ...)
|
| 8db793ae |
}
|
| 56a019fe |
\arguments{
|
| 09388373 |
\item{number_components}{(numeric) The number of principal components to use. The default is \code{2}.\cr}
|
| acec9d54 |
|
| 09388373 |
\item{alpha}{(numeric) A confidence threshold for rejecting samples based on the d-statistic. The default is \code{0.05}.\cr}
|
| acec9d54 |
|
| d0f81a51 |
\item{...}{Additional slots and values passed to \code{struct_class}.}
|
| 56a019fe |
}
|
| 7af536f9 |
\value{
|
| 5d51daa4 |
A \code{
pca_dstat_plot
} object. This object has no \code{output} slots.
See \code{\link[struct]{chart_plot}} in the \code{struct} package to plot this chart object.
|
| 7af536f9 |
}
|
| 883f7f27 |
\description{
|
| d0f81a51 |
A bar chart of the d-statistics for samples in the input PCA model. Samples above the indicated threshold are considered to be outlying.
|
| 883f7f27 |
}
|
| 09388373 |
\section{Inheritance}{
A \code{pca_dstat_plot} object inherits the following \code{struct} classes: \cr\cr
|
| 55546c0b |
\verb{[pca_dstat_plot]} >> \verb{[chart]} >> \verb{[struct_class]}
|
| 09388373 |
}
|
| 1a7cd70b |
\examples{
|
| 09388373 |
M = pca_dstat_plot(
number_components = 2,
alpha = 0.95)
|
| 40be1b5c |
C = pca_dstat_plot()
|
| 1a7cd70b |
}
|
