mcapply: Apply Functions Over mc or mcnode Objects

In mc2d: Tools for Two-Dimensional Monte-Carlo Simulations

Apply Functions Over mc or mcnode Objects

Description

Apply a function on all values or over a given dimension of an ‘⁠mcnode⁠’ object. May be used for all ‘⁠mcnode⁠’ of an ‘⁠mc⁠’ object.

Usage

mcapply(x, margin=c("all", "var", "unc", "variates"), fun, ...)

Arguments

x	A ‘⁠mc⁠’ or a ‘⁠mcnode⁠’ object.
margin	The dimension on which applying the function. Maybe ‘⁠"all"⁠’ (default) to apply the function on all values, ‘⁠"var"⁠’ to apply the function on the variability dimension, ‘⁠"unc"⁠’ to apply the function on the uncertainty dimension, or ‘⁠"variates"⁠’ to apply the function on the variates. Watch out: do not use 'var' for 'variates'
fun	The function to be applied. When applied to a vector of length ‘⁠n⁠’, ‘⁠fun⁠’ should return a vector of length ‘⁠n⁠’ or ‘⁠1⁠’.
...	Optional arguments to ‘⁠fun⁠’.

Value

If ‘⁠fun⁠’ returns a function of length ‘⁠n⁠’ or if ‘⁠margin="all"⁠’, the returned ‘⁠mcnode⁠’s are of type and dimension of ‘⁠x⁠’. In other cases, the type of ‘⁠mcnode⁠’ is changed.

See Also

apply, mc, mcnode.

Examples

data(total)
xVUM
mcapply(xVUM, "unc", sum)
mcapply(xVUM, "var", sum)
mcapply(xVUM, "all", sum)
mcapply(xVUM, "variates", sum)
mcapply(total, "all", exp)

mc2d documentation built on June 22, 2024, 10:54 a.m.