\HeaderA{ns}{Generate a Basis Matrix for Natural Cubic Splines}{ns}
\keyword{smooth}{ns}
\begin{Description}\relax
Generate the B-spline basis matrix for a natural cubic spline.
\end{Description}
\begin{Usage}
\begin{verbatim}
ns(x, df = NULL, knots = NULL, 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 supply \code{df} rather than
knots; \code{ns()} then chooses \code{df - 1 - intercept} knots at
suitably chosen quantiles of \code{x} (which will ignore missing values).
\item[\code{knots}] breakpoints that define the spline.  The default is no
knots; together with the natural boundary conditions this results in
a basis for linear regression on \code{x}.  Typical values are the
mean or median for one knot, quantiles for more knots.  See also
\code{Boundary.knots}.
\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 impose the natural
boundary conditions and 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) + 1 + intercept}.
Attributes are returned that correspond to the arguments to \code{ns},
and explicitly give the \code{knots}, \code{Boundary.knots} etc for
use by \code{predict.ns()}.

\code{ns()} is based on the function \code{\LinkA{spline.des}{spline.des}}.  It
generates a basis matrix for representing the family of
piecewise-cubic splines with the specified sequence of
interior knots, and the natural boundary conditions.  These enforce
the constraint that the function is linear beyond the boundary knots,
which can either be supplied, else default to the extremes of the
data.  A primary use is in modeling formula to directly specify a
natural spline 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{bs}{bs}}, \code{\LinkA{predict.ns}{predict.ns}}, \code{\LinkA{SafePrediction}{SafePrediction}}
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
ns(women$height, df = 5)
summary(fm1 <- lm(weight ~ ns(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)))
\end{ExampleCode}
\end{Examples}

