computeIters-class: An S4 class to return the results of computing iterations...

In JohnNay/sa: Sensitivity Analysis for Complex Computational Models

Description

An S4 class to return the results of computing iterations needed

Prints (cat()) summary of computeIters S4 object

Plots computeIters S4 object

Usage

## S4 method for signature 'computeIters'
summary(object, digits = 3)

## S4 method for signature 'computeIters'
print(x, ...)

## S4 method for signature 'computeIters'
show(object)

## S4 method for signature 'computeIters'
plot(x, outcome_var = "Outcome",
  xlab = "Iterations", ylab = NULL)

Arguments

object	S4 computeIters object @export
digits	Optional numeric vector length one for how many significant digits to print, default is 3. @export
x	The result slot of an object created by compute_iters.
...	ignored @export
outcome_var	Optional character vector.
xlab	Optional character vector.
ylab	Optional character vector.

Value

Returns a ggplot2 object.

Methods (by generic)

• summary:

• print: An S4 method for printing a computeIters S4 object

• show: An S4 method for showing a computeIters S4 object

• plot:

Slots

call

Language from the call of the function.

measure

Character vector length one with the measure used.

result

c("src", "pcc") s3 classes from sensitivity package.

plot_data

data.frame with two columns.

timing

Numeric vector length one with the total elapsed time it took to execute.

session

the results from calling sessionInfo() at end of pc_sa function.

JohnNay/sa documentation built on May 7, 2019, 12:01 p.m.