File: sigma.Rd

package info (click to toggle)
robustbase 0.93-7-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 4,452 kB
  • sloc: fortran: 3,243; ansic: 3,183; sh: 15; makefile: 2
file content (37 lines) | stat: -rw-r--r-- 1,167 bytes parent folder | download | duplicates (4)
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
\name{sigma}
\title{Extract 'Sigma' - Standard Deviation of Errors for Robust Models}
\alias{sigma}
\alias{sigma.lmrob}
\description{
  Extract the estimated standard deviation of the errors, the
  \dQuote{residual standard deviation} (misnomed also
  \dQuote{residual standard error}) from a fitted model.
}
\usage{
% Declare S3 method as the generic is no longer in lme4 for R (>= 2015-06-01):
\S3method{sigma}{lmrob}(object, \dots)
}
\arguments{
  \item{object}{a fitted model.}

  \item{\dots}{additional, optional arguments.  (None are
  used in our methods)}
}
\value{
  the residual standard error as a scalar
}
\details{
  For \R \code{<= 3.2.x}, we provide an (S3) generic function (as e.g.,
  package \CRANpkg{lme4}) and methods for \code{\link{lmrob}},
  \code{\link{nlrob}}, and \code{\link{nls}}.

  From \R \code{>= 3.3.0}, we provide methods for our
  \code{\link{lmrob}} and \code{\link{nlrob}} models.
}
\examples{
      m.cl <-   lm (Y ~ ., data=coleman)
if(getRversion() >= "3.3.0")  sigma(m.cl)  else  summary(m.cl)$sigma
sigma( m1  <- lmrob(Y ~ ., data=coleman) )
sigma( m2  <- lmrob(Y ~ ., data=coleman, setting = "KS2014") )
}
\keyword{models}