print.whatif: Print "whatif" Object

Description Usage Arguments Value Author(s) References See Also Examples

View source: R/print.whatif.R

Description

Prints the information produced by the function whatif, an object of class "whatif", to the screen.

Usage

1
2
## S3 method for class 'whatif'
print(x, print.dist = FALSE, print.freq = FALSE, ...)

Arguments

x

An object of class "whatif", the output of the function whatif.

print.dist

A Boolean; should the matrix of pairwise distances between each counterfactual and data point be printed to the screen, if it was returned? Default is FALSE.

print.freq

A Boolean; should the matrix of cumulative frequencies of distances for each counterfactual be printed to the screen? Default is FALSE.

...

Further arguments passed to and from other methods.

Value

A printout to the screen of the information contained in the whatif output object.

Author(s)

Stoll, Heather hstoll@polsci.ucsb.edu, King, Gary king@harvard.edu and Zeng, Langche zeng@ucsd.edu

References

King, Gary and Langche Zeng. 2006. "The Dangers of Extreme Counterfactuals." Political Analysis 14 (2). Available from https://gking.harvard.edu.

King, Gary and Langche Zeng. 2007. "When Can History Be Our Guide? The Pitfalls of Counterfactual Inference." International Studies Quarterly 51 (March). Available from https://gking.harvard.edu.

See Also

whatif, plot.whatif, summary.whatif, print.summary.whatif

Examples

1
2
3
4
5
6
7
8
9
##  Create example data sets and counterfactuals
my.cfact <- matrix(rnorm(3*5), ncol = 5)
my.data <- matrix(rnorm(100*5), ncol = 5)

##  Evaluate counterfactuals
my.result <- whatif(data = my.data, cfact = my.cfact, mc.cores = 1)

##  Print output object
print(my.result)

WhatIf documentation built on Nov. 14, 2020, 5:13 p.m.

Related to print.whatif in WhatIf...