\HeaderA{bs}{B-Spline Basis for Polynomial Splines}{bs}
\keyword{smooth}{bs}
\begin{Description}\relax
Generate the B-spline basis matrix for a polynomial spline.
\end{Description}
\begin{Usage}
\begin{verbatim}
bs(x, df = NULL, knots = NULL, degree = 3, intercept = FALSE,
   Boundary.knots = range(x))
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{x}] the predictor variable.  Missing values are allowed.
\item[\code{df}] degrees of freedom; one can specify \code{df} rather than
\code{knots}; \code{bs()} then chooses \code{df-degree-1} knots at
suitable quantiles of \code{x} (which will ignore missing values).
\item[\code{knots}] the \emph{internal} breakpoints that define the
spline.  The default is \code{NULL}, which results in a basis for
ordinary polynomial regression.  Typical values are the mean or
median for one knot, quantiles for more knots.  See also
\code{Boundary.knots}.
\item[\code{degree}] degree of the piecewise polynomial---default is 3 for
cubic splines.
\item[\code{intercept}] if \code{TRUE}, an intercept is included in the
basis; default is \code{FALSE}.
\item[\code{Boundary.knots}] boundary points at which to anchor the B-spline
basis (default the range of the data). If both \code{knots} and
\code{Boundary.knots} are supplied, the basis parameters do not
depend on \code{x}. Data can extend beyond \code{Boundary.knots}.
\end{ldescription}
\end{Arguments}
\begin{Value}
A matrix of dimension \code{length(x) * df}, where either \code{df}
was supplied or if \code{knots} were supplied,
\code{df = length(knots) + 3 + intercept}.  Attributes are returned
that  correspond to the arguments to \code{bs}, and explicitly give
the \code{knots}, \code{Boundary.knots} etc for use by
\code{predict.bs()}.

\code{bs()} is based on the function \code{\LinkA{spline.des}{spline.des}()}.
It generates a basis matrix for
representing the family of piecewise polynomials with the specified
interior knots and degree, evaluated at the values of \code{x}.  A
primary use is in modeling formulas to directly specify a piecewise
polynomial term in a model.
\end{Value}
\begin{References}\relax
Hastie, T. J. (1992)
Generalized additive models.
Chapter 7 of \emph{Statistical Models in S}
eds J. M. Chambers and T. J. Hastie, Wadsworth \& Brooks/Cole.
\end{References}
\begin{SeeAlso}\relax
\code{\LinkA{ns}{ns}}, \code{\LinkA{poly}{poly}}, \code{\LinkA{smooth.spline}{smooth.spline}},
\code{\LinkA{predict.bs}{predict.bs}}, \code{\LinkA{SafePrediction}{SafePrediction}}
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
bs(women$height, df = 5)
summary(fm1 <- lm(weight ~ bs(height, df = 5), data = women))

## example of safe prediction
plot(women, xlab = "Height (in)", ylab = "Weight (lb)")
ht <- seq(57, 73, len = 200)
lines(ht, predict(fm1, data.frame(height=ht)))

## Consistency:
x <- c(1:3,5:6)
stopifnot(identical(bs(x), bs(x, df = 3)),
          !is.null(kk <- attr(bs(x), "knots")),# not true till 1.5.1
          length(kk) == 0)
\end{ExampleCode}
\end{Examples}

