print.estimate {EnvStats} | R Documentation |
Print Objects of Class "estimate"
Description
Formats and prints the results of EnvStats functions that estimate
the parameters or quantiles of a probability distribution and optionally
construct confidence, prediction, or tolerance intervals based on a sample
of data assumed to come from that distribution.
This method is automatically called by print
when given an
object of class "estimate"
.
See the help files Estimating Distribution Parameters and Estimating Distribution Quantiles for lists of functions that estimate distribution parameters and quantiles. See the help files Prediction Intervals and Tolerance Intervals for lists of functions that create prediction and tolerance intervals.
Usage
## S3 method for class 'estimate'
print(x, conf.cov.sig.digits = .Options$digits,
limits.sig.digits = .Options$digits, ...)
Arguments
x |
an object of class |
conf.cov.sig.digits |
numeric scalar indicating the number of significant digits to print for the confidence level or coverage of a confidence, prediction, or tolerance interval. |
limits.sig.digits |
numeric scalar indicating the number of significant digits to print for the upper and lower limits of a confidence, prediction, or tolerance interval. |
... |
arguments that can be supplied to the |
Details
This is the "estimate"
method for the generic function
print
.
Prints estimated parameters and, if present in the object, information regarding
confidence, prediction, or tolerance intervals.
Value
Invisibly returns the input x
.
Author(s)
Steven P. Millard (EnvStats@ProbStatInfo.com)
References
Chambers, J. M. and Hastie, T. J. (1992). Statistical Models in S. Wadsworth & Brooks/Cole.
See Also
estimate.object
,
Estimating Distribution Parameters,
Estimating Distribution Quantiles,
Prediction Intervals, Tolerance Intervals,
print
.