The R Project SVN R

Rev

Rev 69495 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 69495 Rev 72927
Line 1... Line 1...
1
% File src/library/splines/man/interpSpline.Rd
1
% File src/library/splines/man/interpSpline.Rd
2
% Part of the R package, https://www.R-project.org
2
% Part of the R package, https://www.R-project.org
3
% Copyright 1995-2015 R Core Team
3
% Copyright 1995-2017 R Core Team
4
% Distributed under GPL 2 or later
4
% Distributed under GPL 2 or later
5
 
5
 
6
\name{interpSpline}
6
\name{interpSpline}
7
\alias{interpSpline}
7
\alias{interpSpline}
8
\title{Create an Interpolation Spline}
8
\title{Create an Interpolation Spline}
Line 11... Line 11...
11
  vectors (\code{default} method), or from a \code{formula} / \code{data.frame}
11
  vectors (\code{default} method), or from a \code{formula} / \code{data.frame}
12
  combination (\code{formula} method).
12
  combination (\code{formula} method).
13
}
13
}
14
\usage{
14
\usage{
15
interpSpline(obj1, obj2, bSpline = FALSE, period = NULL,
15
interpSpline(obj1, obj2, bSpline = FALSE, period = NULL,
-
 
16
             ord = 4L,
16
             na.action = na.fail, sparse = FALSE)
17
             na.action = na.fail, sparse = FALSE)
17
}
18
}
18
\arguments{
19
\arguments{
19
 \item{obj1}{either a numeric vector of \code{x} values or a formula.}
20
 \item{obj1}{either a numeric vector of \code{x} values or a formula.}
20
 \item{obj2}{if \code{obj1} is numeric this should be a numeric vector
21
 \item{obj2}{if \code{obj1} is numeric this should be a numeric vector
Line 23... Line 24...
23
 \item{bSpline}{if \code{TRUE} the b-spline representation is returned,
24
 \item{bSpline}{if \code{TRUE} the b-spline representation is returned,
24
   otherwise the piecewise polynomial representation is returned.
25
   otherwise the piecewise polynomial representation is returned.
25
   Defaults to \code{FALSE}.}
26
   Defaults to \code{FALSE}.}
26
 \item{period}{an optional positive numeric value giving a period for a
27
 \item{period}{an optional positive numeric value giving a period for a
27
   periodic interpolation spline.}
28
   periodic interpolation spline.}
-
 
29
 \item{ord}{an integer specifying the spline \emph{order}, the number of
-
 
30
   coefficients per interval.  \eqn{ord = d+1} where \eqn{d} is the
-
 
31
   \emph{degree} polynomial degree.  Currently, only cubic splines
-
 
32
   (\code{ord = 4}) are implemented.}
28
 \item{na.action}{a optional function which indicates what should happen
33
 \item{na.action}{a optional function which indicates what should happen
29
   when the data contain \code{NA}s.  The default action
34
   when the data contain \code{NA}s.  The default action
30
   (\code{na.omit}) is to omit any incomplete observations.  The
35
   (\code{na.omit}) is to omit any incomplete observations.  The
31
   alternative action \code{na.fail} causes \code{interpSpline} to print
36
   alternative action \code{na.fail} causes \code{interpSpline} to print
32
   an error message and terminate if there are any incomplete
37
   an error message and terminate if there are any incomplete