% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plotSCCcomparisonPanel.R
\name{plotSCCcomparisonPanel}
\alias{plotSCCcomparisonPanel}
\title{Plot group means and SCC comparison overlay}
\usage{
plotSCCcomparisonPanel(
  scc,
  title = NULL,
  zlim = "auto",
  palette = "nih",
  label1 = "Group 1 Mean",
  label2 = "Group 2 Mean",
  label3 = "SCC Overlay",
  overlay = c("positive", "negative", "both", "none"),
  useRawMeans = FALSE
)
}
\arguments{
\item{scc}{A list-like SCC result object, typically returned by
\code{ImageSCC::scc.image()}, containing the components required for
plotting group means and SCC-derived significant points.}

\item{title}{\code{character}, title shown above the panel. If \code{NULL},
the default title is \code{"SCC COMPARISON PANEL"}.}

\item{zlim}{Either \code{"auto"} to compute color limits from the plotted values,
or a numeric vector of length 2 specifying the lower and upper limits of the
fill scale.}

\item{palette}{\code{character}, color palette used in the mean heatmaps.
Supported values are \code{"nih"}, \code{"viridis"}, and \code{"gray"}.}

\item{label1}{\code{character}, title of the first group panel.}

\item{label2}{\code{character}, title of the second group panel.}

\item{label3}{\code{character}, title of the SCC overlay panel.}

\item{overlay}{\code{character}, which SCC-detected points to overlay in the
third panel. Supported values are \code{"positive"}, \code{"negative"},
\code{"both"}, and \code{"none"}.}

\item{useRawMeans}{\code{logical}, if \code{TRUE}, the group means are computed
directly from \code{scc$Ya} and \code{scc$Yb}. If \code{FALSE}, the function
uses \code{scc$Yhat}.}
}
\value{
A patchwork/ggplot object containing three aligned panels:
\itemize{
  \item mean estimate for group 1,
  \item mean estimate for group 2,
  \item SCC overlay panel with detected positive and/or negative points.
}
}
\description{
This function visualizes a two-group Simultaneous Confidence Corridor (SCC)
result as a three-panel figure showing the mean estimate for each group and
an overlay panel with SCC-detected differences.
}
\details{
The first two panels use a shared continuous color scale to facilitate direct
comparison between group mean estimates. The third panel uses a grayscale
background and overlays SCC-detected significant points.

Positive and negative SCC detections are obtained internally using
\code{\link{getPoints}}.
}
\examples{
data("SCCcomp", package = "neuroSCC")
plotSCCcomparisonPanel(SCCcomp, title = "SCC COMPARISON PANEL")

}
\seealso{
\code{\link{SCCcomp}} for the example two-group SCC object used in the examples. \cr
\code{\link{getPoints}} for extraction of SCC-detected significant points. \cr
\code{\link{plotSCCpanel}} for single-group SCC visualization. \cr
\code{\link{plotValidationPanel}} for SCC versus SPM performance visualization.
}
