% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/diss_projection.R
\name{diss_pls}
\alias{diss_pls}
\title{PLS dissimilarity method constructor}
\usage{
diss_pls(
  ncomp = ncomp_by_opc(),
  method = c("pls", "mpls"),
  scale = FALSE,
  return_projection = FALSE
)
}
\arguments{
\item{ncomp}{Component selection method. Can be:
\itemize{
\item A positive integer for a fixed number of components
\item \code{\link{ncomp_fixed}(n)}: explicit fixed selection
\item \code{\link{ncomp_by_var}(min_var)}: retain components explaining
at least \code{min_var} variance each
\item \code{\link{ncomp_by_cumvar}(min_cumvar)}: retain components until
cumulative variance reaches \code{min_cumvar}
\item \code{\link{ncomp_by_opc}()}: optimize using side information
(default; recommended for PLS since \code{Yr} is already required)
}}

\item{method}{Character. PLS algorithm: \code{"pls"} (default) or
\code{"mpls"} (modified PLS, Shenk & Westerhaus 1991).}

\item{scale}{Logical. Scale data? Default \code{FALSE}. Note: PLS always
centers internally.}

\item{return_projection}{Logical. Return projection object?
Default \code{FALSE}.}
}
\value{
An object of class \code{c("diss_pls", "diss_method")}.
}
\description{
Creates a configuration object for computing dissimilarity based on
Mahalanobis distance in PLS score space. Requires \code{Yr} in
\code{dissimilarity()}.
}
\examples{
# Default: OPC optimization (recommended)
diss_pls()

# Fixed number of components
diss_pls(ncomp = 15)

# Custom opc settings
diss_pls(ncomp = ncomp_by_opc(max_ncomp = 50))

# Modified PLS
diss_pls(ncomp = 10, method = "mpls")

}
\seealso{
Component selection: \code{\link{ncomp_by_var}}, \code{\link{ncomp_by_cumvar}},
\code{\link{ncomp_by_opc}}, \code{\link{ncomp_fixed}}

Other dissimilarity methods: \code{\link{diss_pca}},
\code{\link{diss_correlation}}, \code{\link{diss_euclidean}},
\code{\link{diss_cosine}}, \code{\link{diss_mahalanobis}}
}
\author{
\href{https://orcid.org/0000-0002-5369-5120}{Leonardo Ramirez-Lopez}
}
