% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/geom-smooth-3d.R
\name{geom_smooth_3d}
\alias{geom_smooth_3d}
\alias{stat_smooth_3d}
\title{3D surface from smoothed conditional means}
\usage{
geom_smooth_3d(
  mapping = NULL,
  data = NULL,
  stat = StatSmooth3D,
  position = "identity",
  ...,
  method = "loess",
  formula = NULL,
  method.args = list(),
  xlim = NULL,
  ylim = NULL,
  n = NULL,
  grid = NULL,
  direction = NULL,
  trim = NULL,
  domain = c("bbox", "chull"),
  se = FALSE,
  level = 0.95,
  se_fill = NULL,
  se_colour = NULL,
  se_color = NULL,
  se_alpha = 0.5,
  se_linewidth = NULL,
  points = FALSE,
  point_colour = "black",
  point_color = NULL,
  point_fill = NA,
  point_size = 1.5,
  point_shape = 19,
  point_alpha = 1,
  point_stroke = 0.5,
  residuals = FALSE,
  residual_colour = "black",
  residual_color = NULL,
  residual_linewidth = 0.5,
  residual_linetype = 1,
  residual_alpha = 1,
  light = NULL,
  cull_backfaces = FALSE,
  sort_method = NULL,
  force_convex = TRUE,
  scale_depth = TRUE,
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE
)

stat_smooth_3d(
  mapping = NULL,
  data = NULL,
  geom = GeomPolygon3D,
  position = "identity",
  ...,
  method = "loess",
  formula = NULL,
  method.args = list(),
  xlim = NULL,
  ylim = NULL,
  n = NULL,
  grid = NULL,
  direction = NULL,
  trim = NULL,
  domain = c("bbox", "chull"),
  se = FALSE,
  level = 0.95,
  se_fill = NULL,
  se_colour = NULL,
  se_color = NULL,
  se_alpha = 0.5,
  se_linewidth = NULL,
  points = FALSE,
  point_colour = "black",
  point_color = NULL,
  point_fill = NA,
  point_size = 1.5,
  point_shape = 19,
  point_alpha = 1,
  point_stroke = 0.5,
  residuals = FALSE,
  residual_colour = "black",
  residual_color = NULL,
  residual_linewidth = 0.5,
  residual_linetype = 1,
  residual_alpha = 1,
  light = NULL,
  cull_backfaces = FALSE,
  sort_method = NULL,
  force_convex = TRUE,
  scale_depth = TRUE,
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE
)
}
\arguments{
\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}}. This stat
requires \code{x}, \code{y}, and \code{z} aesthetics from the input data. By default, fill is
mapped to \code{after_stat(fitted)}.}

\item{data}{The data to be displayed in this layer. Must contain x, y, z columns.}

\item{stat}{The statistical transformation to use on the data. Defaults to \code{StatSmooth3D}.}

\item{position}{Position adjustment, defaults to "identity". To collapse the result
onto one 2D surface, use \code{position_on_face()}.}

\item{...}{Other arguments passed on to the layer function (typically GeomPolygon3D), such as
aesthetics like \code{colour}, \code{fill}, \code{linewidth}, \code{annotate = annotate_3d(...)}, etc.}

\item{method}{Smoothing method to use. Currently supported:
\itemize{
\item \code{"loess"} (default): Local polynomial regression
\item \code{"lm"}: Linear model
\item \code{"glm"}: Generalized linear model
\item \code{"gam"}: Generalized additive model (requires \code{mgcv} package)
}}

\item{formula}{Model formula. If \code{NULL} (default), uses method-appropriate defaults:
\code{z ~ x + y} for lm and glm, \code{z ~ s(x) + s(y)} for gam, auto for loess.}

\item{method.args}{List of additional arguments passed to the fitting function.
For loess, this might include \code{span} or \code{degree}. For lm, this might include \code{weights}.
For glm, this might include \code{family} (defaults to \code{gaussian()}). For gam, this might
include smoothing parameters or basis specifications.}

\item{xlim, ylim}{Numeric vectors of length 2 giving the range for prediction grid.
If \code{NULL} (default), uses the exact data range with no extrapolation.}

\item{grid, n, direction, trim}{Parameters determining the geometry, resolution, and
orientation of the surface grid. See \link{grid_generation} for details.}

\item{domain}{Character indicating the x-y domain over which to visualize the surface.
The default, \code{"bbox"}, shows predictions over the full rectangular bounding box of
the predictors.The alternative, \code{"chull"}, shows predictions only within the convex
hull of the input data, which prevents extrapolation into unoccupied corners of predictor space.}

\item{se}{Logical indicating whether to display confidence interval bands around
the smooth; if \code{TRUE}, these are rendered as additional surfaces; they inherit
aesthetics from the primary smooth layer unless otherwise specified.
Defaults to \code{FALSE}.}

\item{level}{Level of confidence interval to use (0.95 by default).}

\item{se_fill}{Fill colour for confidence interval bands. If \code{NULL}, inherits from
the main surface \code{fill} aesthetic.}

\item{se_colour, se_color}{Color for confidence interval band borders. If \code{NULL},
inherits from the main surface \code{color} aesthetic.}

\item{se_alpha}{Alpha transparency for confidence interval bands. Defaults to 0.5.}

\item{se_linewidth}{Line width for confidence interval band borders. If \code{NULL},
inherits from the main surface \code{linewidth} aesthetic.}

\item{points}{Logical indicating whether to overlay the original data points
on the fitted surface. Points are depth-sorted together with the surface
polygons for proper 3D rendering. Point styling is controlled via the
\verb{point_*} parameters; mapped aesthetics from the layer are not inherited
by annotation points. Default is \code{FALSE}.}

\item{point_colour, point_color}{Color for data points. Defaults to \code{"black"}.}

\item{point_fill}{Fill color for data points (only relevant for shapes 21-25).
Defaults to \code{NA} (transparent).}

\item{point_size}{Size of data points.}

\item{point_shape}{Shape of data points.}

\item{point_alpha}{Alpha transparency for data points.}

\item{point_stroke}{Stroke width for data points.}

\item{residuals}{Logical indicating whether to draw residual lines connecting
data points to the fitted surface. Default is \code{FALSE}. Residual styling is
controlled via the \verb{residual_*} parameters. Note: residual lines may render
incorrectly when combined with \code{se = TRUE}, as the lines intersect the
confidence interval surfaces and cannot be split at intersection points.}

\item{residual_colour, residual_color}{Color for residual lines.}

\item{residual_linewidth}{Line width for residual lines.}

\item{residual_linetype}{Line type for residual lines.}

\item{residual_alpha}{Alpha transparency for residual lines.}

\item{light}{A lighting specification object created by \code{\link[=light]{light()}}, \code{light("none")}
or the string \code{"none"} to disable lighting, or \code{NULL} to inherit plot-level
lighting. Set plot-level lighting by adding \code{\link[=light]{light()}} to the plot, and
layer-specific lighting via the \code{light} argument of \verb{geom_*_3d()} functions,
which takes precedence.}

\item{cull_backfaces}{Logical indicating whether to remove back-facing polygons
from rendering. This is primarily for performance optimization but may be useful
for aesthetic reasons in some situations. Backfaces are determined using
screen-space winding order after 3D transformation. Defaults vary by geometry
type: FALSE for open surface-type geometries, TRUE for solid objects (hulls,
voxels, etc. where backfaces are generally hidden unless frontfaces are transparent
or explicitly disabled).}

\item{sort_method}{Depth sorting algorithm. See \link{sorting_methods} for details.}

\item{force_convex}{Logical indicating whether to remove polygon vertices that are not part of the
convex hull. Default value varies by geom. Specifying TRUE can help reduce artifacts in surfaces
that have polygon tiles that wrap over a visible horizon. For prism-type geoms like columns and
voxels, FALSE is safe because polygons fill always be convex.}

\item{scale_depth}{Controls whether polygon linewidths are scaled to make closer lines
wider and farther lines narrower, based on the mean depth of a polygon. \code{TRUE}
(the default) applies full scaling and \code{FALSE} disables it; a number sets the
strength directly, where \code{1} matches \code{TRUE}, \code{0} matches \code{FALSE}, values below
1 subdue the effect and values above 1 exaggerate it. This affects the layer
only; use \code{coord_3d(scale_depth = )} for gridlines, cube borders, axis ticks,
and axis text.}

\item{na.rm}{If \code{FALSE}, missing values are removed.}

\item{show.legend}{Logical indicating whether this layer should be included in legends.}

\item{inherit.aes}{If \code{FALSE}, overrides the default aesthetics.}

\item{geom}{The geometric object used to display the data. Defaults to \code{GeomPolygon3D}.}
}
\value{
A \code{Layer} object that can be added to a ggplot.
}
\description{
A 3D version of \code{ggplot2::geom_smooth()}.
Creates surfaces by fitting smoothing models to scattered (x,y,z) data points.
The fitted statistical model is evaluated on a regular grid and rendered as a
3D surface with optional standard error surfaces.
}
\section{Aesthetics}{

\code{stat_smooth_3d()} requires the following aesthetics from input data:
\itemize{
\item \strong{x}: X coordinate
\item \strong{y}: Y coordinate
\item \strong{z}: Z coordinate (response variable to be smoothed)
}
}

\section{Computed variables specific to StatSmooth3D}{

\itemize{
\item \code{level}: Type of surface ("fitted", "upper CI", or "lower CI" for confidence bands)
\item \code{fitted}: Smoothed predictions (same as \code{z} when \code{level == "fitted"})
\item \code{se}: Standard errors of the fitted values (available when \code{se = TRUE})
}
}

\section{Computed variables}{

The following computed variables are available via \code{after_stat()}:
\itemize{
\item \code{x}, \code{y}, \code{z}: Grid coordinates and function values
\item \code{normal_x}, \code{normal_y}, \code{normal_z}: Surface normal components
\item \code{slope}: Gradient magnitude from surface calculations
\item \code{aspect}: Direction of steepest slope from surface calculations
\item \code{dzdx}, \code{dzdy}: Partial derivatives from surface calculation
}
}

\examples{
# Generate scattered 3D data
set.seed(123)
d <- data.frame(
  x = runif(100, -1, 3),
  y = runif(100, -3, 3)
)
d$z <- abs(1 + d$x^2 - d$y^2 + rnorm(100, 0, 1))

# Base plot
p <- ggplot(d, aes(x, y, z)) +
  coord_3d(light = NULL) +
  scale_fill_viridis_c()

# Basic smooth surface with default loess model
p + geom_smooth_3d()

\donttest{

# Show data points
p + geom_smooth_3d(points = TRUE)

# Show data points with residual lines
p + geom_smooth_3d(points = TRUE, residuals = TRUE,
      point_color = "red", alpha = .8)

# Linear model surface with 90\% confidence intervals
p + geom_smooth_3d(aes(fill = after_stat(level)),
      method = "lm", color = "black", se = TRUE,
      level = 0.99, se_alpha = .7, n = 10) +
      scale_fill_manual(values = c("red", "darkorchid4", "steelblue"))

# Linear model surface with custom model formula
p + geom_smooth_3d(method = "lm", n = 10,
      formula = z ~ poly(x, 2) + poly(y, 2) + x:y)

# Loess with custom span parameter, and lighting effects
p + geom_smooth_3d(
      method = "loess", method.args = list(span = 0.3),
      fill = "steelblue", color = "white", n = 20,
      light = light(direction = c(0, -1, 0), color = FALSE))

# GLM with gamma family and log link
p + geom_smooth_3d(
      method = "glm", n = 10,
      method.args = list(family = Gamma(link = "log")),
      formula = z ~ poly(x, 2) + poly(y, 2))

# Visualize uncertainty with computed "standard error" variable
p + geom_smooth_3d(aes(fill = after_stat(se * 2))) +
  scale_fill_viridis_c()

# Extend surface beyond training data range (explicit extrapolation)
p + geom_smooth_3d(method = "lm", xlim = c(-5, 5), ylim = c(-5, 5))

# Clip surface to predictor convex hull
# to prevent extrapolation into corner areas
p + geom_smooth_3d(method = "lm", domain = "chull")

# Specify alternative grid geometry
p + geom_smooth_3d(grid = "right1", n = 30, direction = "y")

# Separate fits for data subgroups
ggplot(mtcars, aes(wt, mpg, qsec, fill = factor(cyl))) +
  geom_smooth_3d(method = "lm", alpha = .7,
    xlim = c(0, 5), ylim = c(0, 40)) + # specify shared domain
  coord_3d() + theme_light()

}

}
\seealso{
\code{\link[=stat_surface_3d]{stat_surface_3d()}} for surfaces from existing grid data,
\code{\link[=stat_function_3d]{stat_function_3d()}} for mathematical function surfaces.
}
