https://github.com/cran/rstpm2
Raw File
Tip revision: 40c3033311c24f521975a0b6e8685b3400562362 authored by Mark Clements on 10 May 2022, 11:30:05 UTC
version 1.5.6
Tip revision: 40c3033
eform.Rd
\name{eform.stpm2}
\alias{eform}
\alias{eform.stpm2}
\alias{eform.default}
\title{
S3 method for to provide exponentiated coefficents with confidence intervals. 
}
\description{
S3 method for to provide exponentiated coefficents with confidence intervals. 
}
\usage{
eform(object, ...)
\method{eform}{stpm2}(object, parm, level = 0.95, method = c("Profile","Delta"), name = "exp(beta)")
\method{eform}{default}(object, parm, level = 0.95, method =
c("Delta","Profile"), name = "exp(beta)", ...)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
  \item{object}{
regression object
}
  \item{parm}{
not currently used
}
  \item{level}{
significance level for the confidence interval
}
  \item{method}{
method for confidence interval estimation
}
  \item{name}{
name for the fitted value
}
  \item{...}{
    other arguments
}
}
%% \details{
%% %%  ~~ If necessary, more details than the description above ~~
%% }
%% \value{
%% %%  ~Describe the value returned
%% %%  If it is a LIST, use
%% %%  \item{comp1 }{Description of 'comp1'}
%% %%  \item{comp2 }{Description of 'comp2'}
%% %% ...
%% }
%% \references{
%% %% ~put references to the literature/web site here ~
%% }
%% \author{
%% %%  ~~who you are~~
%% }
%% \note{
%% %%  ~~further notes~~
%% }

%% ~Make other sections like Warning with \section{Warning }{....} ~

%% \seealso{
%% %% ~~objects to See Also as \code{\link{help}}, ~~~
%% }
%% \examples{
%% ##---- Should be DIRECTLY executable !! ----
%% ##-- ==>  Define data, use random,
%% ##--	or do  help(data=index)  for the standard data sets.

%% ## The function is currently defined as
%% function (object, parm, level = 0.95, method = c("Profile"), 
%%     name = "exp(beta)") 
%% {
%%     method <- match.arg(method)
%%     if (missing(parm)) 
%%         parm <- TRUE
%%     estfun <- switch(method, Profile = confint)
%%     val <- exp(cbind(coef = coef(object), estfun(object, level = level)))
%%     colnames(val) <- c(name, colnames(val)[-1])
%%     val[parm, ]
%%   }
%% }
%% % Add one or more standard keywords, see file 'KEYWORDS' in the
%% % R documentation directory.
%% \keyword{ ~kwd1 }% use one of  RShowDoc("KEYWORDS")
%% \keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
back to top