cv_abm-class: An S4 class to return the results of using a cv_abm to...

In JohnNay/eat: Empirical Agent Training Software for Data-Driven Modeling

Description

An S4 class to return the results of using a cv_abm to estimate and test an ABM

Prints (cat()) summary of cv_abm S4 object.

Turns cv_abm S4 object into useful outputs for summary or plotting.

Plots cv_abm S4 object

Usage

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

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

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

## S4 method for signature 'cv_abm,character'
performance(results, output = c("MSE", "cor",
  "cor_pval", "SE", "plot"))

## S4 method for signature 'cv_abm,ANY'
plot(x, y, ncol = 4)

Arguments

x	S4 cv_abm object
...	ignored @export
object	S4 cv_abm object
digits	Optional numeric vector length one for how many significant digits to print, default is 3. @export
results	S4 cv_abm object
output	Optional character vector length one indicating what the desired output is, must be one of: c("MSE", "cor", "cor_pval", "SE", "plot").
y	not used.
ncol	optional numeric vector length one specifying number of columns of the faceted subsetted graphs, i.e. how many columns ggplot2 will use when wrapping the structures around.

Methods (by generic)

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

• show: @export

• summary:

• performance: An S4 method for extracting performance measures of an cv_abm S4 object

• plot: Plots cv_abm results.

Slots

call

Language from the call of the function cv_abm.

predicted_patterns

List with predicted vec length 1, actual vec length 1, null_model vec length 1, dynamics vec, simdata data.frame

timing

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

diagnostics

Character vector length one, to be printed with base::cat().

session

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

JohnNay/eat documentation built on May 7, 2019, noon