Summarise: Summarise simulated data using various population comparison...

Description Usage Arguments Value See Also Examples

Description

This collapses the simulation results within each condition to composite estimates such as RMSE, bias, Type I error rates, coverage rates, etc. See the See Also section below for useful functions to be used within Summarise.

Usage

1
Summarise(condition, results, fixed_objects = NULL)

Arguments

condition

a single row from the design input from runSimulation (as a data.frame), indicating the simulation conditions

results

a data.frame (if Analyse returned a numeric vector) or a list (if Analyse returned a list or multi-rowed data.frame) containing the analysis results from Analyse, where each cell is stored in a unique row/list element

fixed_objects

object passed down from runSimulation

Value

must return a named numeric vector or data.frame with the desired meta-simulation results

See Also

bias, RMSE, RE, EDR, ECR, MAE

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 

mysummarise <- function(condition, results, fixed_objects = NULL){

    #find results of interest here (alpha < .1, .05, .01)
    lessthan.05 <- EDR(results, alpha = .05)

    # return the results that will be appended to the design input
    ret <- c(lessthan.05=lessthan.05)
    ret
}


## End(Not run)


Search within the SimDesign package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.