Object returned by uncertMC
calls and by uncertainty
with method="MC"
.
summary.uncertMC
is currently an alias for print.uncertMC
.
# S3 method for uncertMC
print(x, digits=NULL, right=FALSE,
…, simplify=TRUE, minimise=FALSE) # S3 method for uncertMC
summary(object, digits=NULL, right=FALSE,
…, simplify=TRUE, minimise=FALSE)
An object of class "uncertMC"
Number of digits to display in budget and (if present) distribution parameter lists.
Passed to format
for distribution parameter list and to print.data.frame
for output.
If TRUE, strings in uncertainty budget are right-justified.
This differs from the default in print.data.frame
.
Other parameters passed to print.data.frame
If TRUE
, only the call, evaluation method, budget, value y
and combined uncertainty (u.y) are printed.
If TRUE
, the header, call, expr
and evaluation method
are suppressed; this is the mode used when printing an uncertMC
object as part of an
uncert
object.
print
and summary
methods invisibly return the original object.
The print method provides a formatted printout of the object. By default,
simplify=TRUE
; this displays a shortened listing. Columns in $data
are
suppressed if all NA.
summary is currently an alias for the print method.
An object of class "uncertMC" inherits from class "uncert". In addition to the contents of the "uncert" object, it contains the results from the MC replication as a list MC. The complete description is:
The matched call
The expression, formula or function supplied to uncertMC
.
The uncertainty evaluation method used (always 'MC').
The number of Monte Carlo replicates used.
A data frame consisting of:
The starting values x
.
The standard uncertainties in input quantities (originally provided as u
)
The degrees of freedom asscociated with u
Sensitivity coefficients estimated from the MC output (see uncertMC
for how this is done).
If available, a named list of the distributions associated with u
.
The list contains either root nams of distribution functions (e.g "norm"
or
function definitions.
If available, a list of lists of parameters describing the
distributions associated with u
.
If supplied, any relevant parameters other than those in $budget$x
(typically addditional constants passed to function or expression methods)
The covariance matrix used
The correlation matrix used
A data frame of covariances between x and y. The Row names correspond
to the correlation method used. For uncertMC
objects only
"pearson"
is currently supported (because "kendall"
and "spearman"
take a very long time to compute)
A data frame of correlations between x and y, of the same form as cov.xy
A list containing:
The value of .Random.seed
when uncertMC
was called.
The B
Monte Carlo replicates of the standard uncertainty
calculated as sd(y)
.
If uncertMC
is called with keep.x=TRUE
, a data frame
whose columns are the Monte Carlo replicates of the variables in x
.
None.
# NOT RUN {
set.seed(13*17)
expr <- expression(a+b*2+c*3+d/2)
x <- list(a=1, b=3, c=2, d=11)
u <- lapply(x, function(x) x/10)
u.expr<-uncertMC(expr, x, u, distrib=rep("norm", 4), method="MC")
print(u.expr)
# }
Run the code above in your browser using DataLab