describe_data: Describe an oracle (simulated) dataset.

In lmiratrix/blkvar: ATE and Treatment Variation Estimation for Blocked and Multisite RCTs

Describe an oracle (simulated) dataset.

Description

This utility function gives various summary statistics (at the block level) for a dataset with all potential outcomes given.

Usage

describe_data(data, Y0 = "Y0", Y1 = "Y1", Z = "Z", sid = "sid")

Arguments

data	Dataframe with defined Y0, Y1 (the potential outcomes), Z (sample treatment assignment vector), and sid (a categorical blocking variable).
Y0	name of Y0 column
Y1	name of Y1 column
Z	example vector of treatment assignment that allows for calculation of proportion treated and so forth.
sid	Name of the block ID column in the dataframe.

Value

(invisible) the summary stats by block. Side effect of printing to screen the description of the data.

lmiratrix/blkvar documentation built on Nov. 18, 2024, 1:27 p.m.