predict.FindIt: Computing predicted values for each sample in the data.

predict.FindItR Documentation

Computing predicted values for each sample in the data.

Description

predict.FindIt takes an output from FindIt and returns estimated treatment effects when treat.type="single" and predicted outcomes for each treatment combination when treat.type="multiple".

Usage

## S3 method for class 'FindIt'
predict(
  object,
  newdata,
  sort = TRUE,
  decreasing = TRUE,
  wts = 1,
  unique = FALSE,
  ...
)

Arguments

object

An output object from FindIt.

newdata

An optional data frame in which to look for variables with which to predict. If omitted, the data used in FindIt is used.

sort

Whether to sort samples according to estimated treatment effects.

decreasing

When sort=TRUE, whether to sort the output in descending order or not.

wts

Weights.

unique

If unique=TRUE, predict returns estimated treatment effects or predicted outcomes for unique samples.

...

further arguments passed to or from other methods.

Details

Useful for computing estimated treatment effects or predicted outcomes for each treatment combination. By using newdata, researchers can compute them for any samples.

Value

data

A matrix of estimated treatment effects when treat.type="single" and predicted outcomes for each treatment combination when treat.type="multiple".

Author(s)

Naoki Egami, Marc Ratkovic and Kosuke Imai.

Examples


## See the help page for FindIt() for an example.
	

kosukeimai/FindIt documentation built on March 19, 2024, 11:25 a.m.