csReport: Report results of conditioning data

Description Usage Arguments Examples

View source: R/csReport.R

Description

Report results of data analyses run with the csCompare.

Usage

1
2
csReport(csCompareObj = NULL, csSensitivityObj = NULL, save = FALSE,
  fileName = "report", alphaLevel = 0.05, interpretation = FALSE)

Arguments

csCompareObj

a list or data frame returned from the csCompare function. The object should be of class csCompare.

csSensitivityObj

Sensitivity analysis results returned from the csSensitivity function. The object should be of class csSensitivity.

save

If code argument is set to FALSE (default), the results are printed on the sceen. Otherwise, a '.txt' file with the report is generated.

fileName

The file name of the produced report. The argument is ignored if save is set to FALSE.

alphaLevel

The alpha level to be used for determining significant or non-significant results.

interpretation

Should an interpretation of the results be included? (FALSE). In case of the Bayesian results, the results are interpreted according to Lee and Wagenmakers (2013).

Examples

1
2
3
tmp <- csCompare(cs1 = rnorm(n = 100, mean = 10),
cs2 = rnorm(n = 100, mean = 9))
csReport(tmp)

condir documentation built on May 29, 2017, 7:54 p.m.