This routine is a front end to the survreg
routine in the
survival
package.
There are many additional options that are supported and documented
in survfit
. Only a few have relevance to the evironmental
sciences.
A very important option is `dist' which specifies the distributional
model to use in the regression. The default is `lognormal'.
Another important option is `conf.int'. This is NOT an option to
survreg
but is an added feature (due to some arcane details of
R it can't be documented above). The `conf.int' option specifies
the level for a two-sided confidence interval on the regression.
The default is 0.95. This interval will be used in when the output
object is passed to other generic functions such as mean
and quantile
. See Examples below.
Also supported is a `gaussian' or a normal distribution. The use of
a gaussian distribution requires an interval censoring context for
left-censored data. Luckily, this routine automatically does this
for you -- simply specify `gaussian' and the correct manipulations
are done.
If any other distribution is specified besides lognormal or gaussian,
the return object is a raw survreg object -- it is up to the user to
`do the right thing' with the output (and input for that matter).
If you are using the formula interface: The censored
and
groups
parameters are not specified -- all information is provided
via a formula as the obs
parameter. The formula must have a
Cen
object as the response on the left of the ~
operator and,
if desired, terms separated by + operators on the right.
See Examples below.