File: predict.stepmented.Rd

package info (click to toggle)
r-cran-segmented 2.1-4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,484 kB
  • sloc: makefile: 2
file content (84 lines) | stat: -rw-r--r-- 3,391 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
\name{predict.stepmented}
\alias{predict.stepmented}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{
Predict method for stepmented model fits
}
\description{
Returns predictions and optionally associated quantities (standard errors or confidence intervals) from a fitted stepmented model object.
}
\usage{
\method{predict}{stepmented}(object, newdata, se.fit=FALSE, interval=c("none","confidence", "prediction"), 
            type = c("link", "response"), na.action=na.omit, level=0.95, .coef=NULL, 
            .vcov=NULL, apprx.fit=c("none","cdf"), apprx.se=c("cdf","none"), ...)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
  \item{object}{
a fitted stepmented model coming from \code{stepmented.lm} or \code{stepmented.glm}.
}
  \item{newdata}{
An optional data frame in which to look for variables with which to predict. If omitted, the fitted values are used.
}
  \item{se.fit}{
Logical. Should the standard errors be returned?
}
  \item{interval}{
Which interval? See \code{\link{predict.lm}}
}
  \item{type}{
Predictions on the link or response scale? Only if \code{object} is a stepmented glm.
}
  \item{na.action}{
How to deal with missing data,  \emph{if} \code{newdata} include them.
}
  \item{level}{
The confidence level.
}
  \item{.coef}{ The regression parameter estimates. If unspecified (i.e. \code{NULL}), it is computed internally by \code{coef()}.}
  \item{.vcov}{ The estimate covariance matrix. If unspecified (i.e. \code{NULL}), it is computed internally by \code{vcov.stepmented()}.}
  \item{apprx.fit}{ The approximation of the \eqn{(x>\hat\psi)} used to compute the predictions/fitted values of the piece-wise relationships. }
  \item{apprx.se}{ The same abovementioned approximation to compute the standard error.}
  \item{\dots}{
further arguments, for instance \code{k} to be passed to \code{\link{vcov.stepmented}}.
}
}
\details{
Basically \code{predict.stepmented} builds the right design matrix accounting for breakpoint and passes it 
to \code{predict.lm} or \code{predict.glm} depending on the actual model fit \code{object}.
}
\value{
\code{predict.stepmented} produces a vector of predictions with possibly associated standard errors or confidence intervals. 
See \code{predict.lm}, \code{predict.glm}, or \code{\link{predict.segmented}}.
}
%\references{
%% ~put references to the literature/web site here ~
%}
\author{
Vito Muggeo
}
%\note{
%If \code{type="terms"}, \code{predict.stepmented} returns predictions for each component of the stepmented term. 
%Namely if `my.x' is the stepmented variable, predictions for `my.x', `U1.my.x' and `psi1.my.x' are returned. These are
%meaningless individually, however their sum provides the predictions for the stepmented term.
%}

\section{Warning }{
For stepmented glm fits with offset, \code{predict.stepmented} returns the fitted values \emph{including} the offset. 
}

\seealso{
\code{\link{stepreg}}, \code{\link{stepmented}}, \code{\link{plot.stepmented}}, \code{\link{predict.lm}}, \code{\link{predict.glm}}
}
\examples{
n=10
x=seq(-3,3,l=n)
set.seed(1515)
y <- (x<0)*x/2 + 1 + rnorm(x,sd=0.15)
segm <- segmented(lm(y ~ x), ~ x, psi=0.5)
predict(segm,se.fit = TRUE)$se.fit
}
% \dontrun{..}
% KEYWORDS - R documentation directory.
\keyword{models} 
\keyword{regression}