evaluate_smooth: Evaluate a smooth

Description Usage Arguments Value Examples

Description

Evaluate a smooth at a grid of evenly spaced value over the range of the covariate associated with the smooth. Alternatively, a set of points at which the smooth should be evaluated can be supplied.

Usage

1
2
evaluate_smooth(object, smooth, n = 100, newdata = NULL,
  unconditional = FALSE, inc.mean = FALSE, dist = 0.1)

Arguments

object

an object of class "gam" or "gamm".

smooth

character; a single smooth to evaluate.

n

numeric; the number of points over the range of the covariate at which to evaluate the smooth.

newdata

a vector or data frame of points at which to evaluate the smooth.

unconditional

logical; should confidence intervals include the uncertainty due to smoothness selection? If TRUE, the corrected Bayesian covariance matrix will be used.

inc.mean

logical; should the uncertainty in the model constant term be included in the standard error of the evaluate values of the smooth? Currently not implemented.

dist

numeric; if greater than 0, this is used to determine when a location is too far from data to be plotted when plotting 2-D smooths. The data are scaled into the unit square before deciding what to exclude, and dist is a distance within the unit square. See mgcv::exclude.too.far() for further details.

Value

A data frame, which is of class "evaluated_1d_smooth" or evaluated_2d_smooth, which inherit from classes "evaluated_smooth" and "data.frame".

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
library("mgcv")
set.seed(2)
dat <- gamSim(1, n = 400, dist = "normal", scale = 2)
m1 <- gam(y ~ s(x0) + s(x1) + s(x2) + s(x3), data = dat, method = "REML")

head(evaluate_smooth(m1, "s(x1)"))

## 2d example
set.seed(2)
dat <- gamSim(2, n = 4000, dist = "normal", scale = 1)
m2 <- gam(y ~ s(x, z, k = 30), data = dat$data, method = "REML")

head(evaluate_smooth(m2, "s(x,z)", n = 100))

gavinsimpson/tsgam documentation built on May 16, 2019, 10:11 p.m.