generate_permutations

Core engine used by <code>FRTCI</code> and <code>FRTCI_interact</code> to compute
the randomization distribution of a test statistic under permuted
treatment assignments.

internal

Implements methods developed by Ding, Feller, and Miratrix (2016) <doi:10.1111/rssb.12124> <doi:10.48550/arXiv.1412.5000>,
and Ding, Feller, and Miratrix (2018) <doi:10.1080/01621459.2017.1407322> <doi:10.48550/arXiv.1605.06566>
for testing whether there is unexplained variation in treatment effects across observations, and for characterizing
the extent of the explained and unexplained variation in treatment effects. The package includes wrapper functions
implementing the proposed methods, as well as helper functions for analyzing and visualizing the results of the test.

Ben Fifield

hettx

Fisherian and Neymanian Methods for Detecting and Measuring
Treatment Effect Variation

Peng Ding

Avi Feller

Luke Miratrix

generate_permutations function

<dl><dt>Y</dt>
<dd>Outcome vector.</dd>
<dt>Z</dt>
<dd>Treatment assignment vector (0/1).</dd>
<dt>test.stat</dt>
<dd>Test statistic function taking (Y, Z, ...).</dd>
<dt>Y0.mat</dt>
<dd>N x grid.size matrix of imputed control potential outcomes.</dd>
<dt>Y1.mat</dt>
<dd>N x grid.size matrix of imputed treated potential outcomes.</dd>
<dt>B</dt>
<dd>Number of permutations.</dd>
<dt>n.cores</dt>
<dd>Number of cores for parallel computation.</dd>
<dt>get.z.star</dt>
<dd>Optional function to generate permuted Z vectors.
If NULL, uses <code>sample(Z)</code>.</dd>
<dt>verbose</dt>
<dd>Whether to display a progress bar. Default is TRUE.</dd>
<dt>...</dt>
<dd>Additional arguments passed to <code>test.stat</code>.</dd></dl>

Arguments

Generate permutation distributions for FRT tests — generate_permutations

<dl>

<dt>Y</dt>
<dd>Outcome vector.</dd>


<dt>Z</dt>
<dd>Treatment assignment vector (0/1).</dd>


<dt>test.stat</dt>
<dd>Test statistic function taking (Y, Z, ...).</dd>


<dt>Y0.mat</dt>
<dd>N x grid.size matrix of imputed control potential outcomes.</dd>


<dt>Y1.mat</dt>
<dd>N x grid.size matrix of imputed treated potential outcomes.</dd>


<dt>B</dt>
<dd>Number of permutations.</dd>


<dt>n.cores</dt>
<dd>Number of cores for parallel computation.</dd>


<dt>get.z.star</dt>
<dd>Optional function to generate permuted Z vectors.
If NULL, uses <code>sample(Z)</code>.</dd>


<dt>verbose</dt>
<dd>Whether to display a progress bar. Default is TRUE.</dd>


<dt>...</dt>
<dd>Additional arguments passed to <code>test.stat</code>.</dd>

</dl>

generate_permutations: Generate permutation distributions for FRT tests

Description

Usage

Value

Arguments