Update README.md
Browse files
README.md
CHANGED
|
@@ -65,24 +65,19 @@ These data were used to:
|
|
| 65 |
- `VaryNAndD_main.parquet` (optional)
|
| 66 |
Parquet version of the same table (faster to load in many environments).
|
| 67 |
|
| 68 |
-
- `CODE/` (optional, if you choose to include)
|
| 69 |
-
- `FastSRR_VaryNAndD.R`
|
| 70 |
-
- `FastRR_PlotFigs.R`
|
| 71 |
-
Exact R scripts used to generate the raw CSV files and figures.
|
| 72 |
-
|
| 73 |
---
|
| 74 |
|
| 75 |
## Main Columns (schema overview)
|
| 76 |
|
| 77 |
Below is an overview of the most important columns you will encounter in `VaryNAndD_main.*`.
|
| 78 |
-
Names are taken directly from the R code (especially the `res <- as.data.frame(cbind(...))` section in `FastSRR_VaryNAndD.R` and the subsequent processing in `FastRR_PlotFigs.R`).
|
| 79 |
|
| 80 |
### Core design variables
|
| 81 |
|
| 82 |
- `treatment_effect` – Constant treatment effect used in the simulation (e.g., `0.1`).
|
| 83 |
- `SD_inherent` – Baseline SD of potential outcomes (`SD_inherent` in `GenerateCausalData`).
|
| 84 |
- `n_units` – Total number of experimental units.
|
| 85 |
-
- `k_covars` – Number of covariates.
|
|
|
|
| 86 |
- `maxDraws` – Maximum number of candidate randomizations drawn (e.g., `1e5`, `2e5`).
|
| 87 |
- `findFI` – Logical (`TRUE`/`FALSE`): whether fiducial intervals were computed.
|
| 88 |
- `approximate_inv` – Logical (`TRUE`/`FALSE`): whether approximate inverse / stabilized linear algebra was used.
|
|
@@ -94,44 +89,6 @@ Names are taken directly from the R code (especially the `res <- as.data.frame(c
|
|
| 94 |
- `"BaseR"` (pure R baseline)
|
| 95 |
- `monte_i` – Monte Carlo replication index.
|
| 96 |
|
| 97 |
-
### Rerandomization configuration
|
| 98 |
-
|
| 99 |
-
- `prob_accept` – Target acceptance probability (`randomization_accept_prob`).
|
| 100 |
-
- `accept_prob` – Same or related acceptance probability field (used within plotting code).
|
| 101 |
-
|
| 102 |
-
### Randomization-test & FI summaries
|
| 103 |
-
|
| 104 |
-
These are typically aggregated across Monte Carlo replications and/or over covariate-dimension strata:
|
| 105 |
-
|
| 106 |
-
- `p_value` – Mean p-value across replications, by `k_covars` and acceptance probability.
|
| 107 |
-
- `p_value_se` – Standard error of the above p-value estimates.
|
| 108 |
-
- `min_p_value` – Average minimum achievable p-value (`1/(1 + n_accepted)`), reflecting how many accepted randomizations were available.
|
| 109 |
-
- `number_successes` – Average number of accepted randomizations (per configuration).
|
| 110 |
-
- `tau_hat_mean` – Mean estimated treatment effect across replications.
|
| 111 |
-
- `tau_hat_var` – Variance of the estimated treatment effect across replications.
|
| 112 |
-
- `FI_lower_vec`, `FI_upper_vec` – Mean lower/upper endpoints of fiducial intervals.
|
| 113 |
-
- `FI_width` – Median width of the fiducial interval (where available).
|
| 114 |
-
- `truth_covered` – Average indicator for whether the interval covered the true treatment effect.
|
| 115 |
-
|
| 116 |
-
### Estimator-selection diagnostics (acceptance-prob “minimization”)
|
| 117 |
-
|
| 118 |
-
These summarize how well different strategies for choosing the optimal acceptance probability perform:
|
| 119 |
-
|
| 120 |
-
- `colMeans_mean_p_value_matrix`, `colMeans_median_p_value_matrix`, `colMeans_modal_p_value_matrix` –
|
| 121 |
-
Average p-value summaries used to define estimators of the “best” acceptance probability.
|
| 122 |
-
|
| 123 |
-
- `bias_select_p_via_mean`, `rmse_select_p_via_mean` –
|
| 124 |
-
Bias and RMSE when selecting the acceptance probability based on the mean p-value.
|
| 125 |
-
|
| 126 |
-
- `bias_select_p_via_median`, `rmse_select_p_via_median` –
|
| 127 |
-
Bias and RMSE when selecting the acceptance probability based on the median p-value.
|
| 128 |
-
|
| 129 |
-
- `bias_select_p_via_mode`, `rmse_select_p_via_mode` –
|
| 130 |
-
Bias and RMSE when selecting the acceptance probability based on the modal p-value.
|
| 131 |
-
|
| 132 |
-
- `bias_select_p_via_baseline`, `rmse_select_p_via_baseline` –
|
| 133 |
-
Bias and RMSE of a naive baseline strategy (e.g., choosing acceptance probability at random), used as a comparison.
|
| 134 |
-
|
| 135 |
### Timing and hardware metadata
|
| 136 |
|
| 137 |
Timing quantities are used to produce the benchmark plots in the paper:
|
|
@@ -143,8 +100,6 @@ Timing quantities are used to produce the benchmark plots in the paper:
|
|
| 143 |
- `nCores` – Number of CPU cores from `benchmarkme::get_cpu()`.
|
| 144 |
- `cpuModel` – CPU model name from `benchmarkme::get_cpu()`.
|
| 145 |
|
| 146 |
-
> **Note:** Because the scripts were developed iteratively, some columns may appear duplicated or with slightly redundant naming (e.g., multiple `randtest_time`-like fields). For replication of the paper’s figures, these are harmless; users may drop redundant columns as needed.
|
| 147 |
-
|
| 148 |
---
|
| 149 |
|
| 150 |
## How to use the dataset
|
|
@@ -193,7 +148,7 @@ You can then:
|
|
| 193 |
|
| 194 |
## Citation
|
| 195 |
|
| 196 |
-
If you use this dataset,
|
| 197 |
|
| 198 |
```bibtex
|
| 199 |
@misc{goldstein2025fastrerandomizefastrerandomizationusing,
|
|
|
|
| 65 |
- `VaryNAndD_main.parquet` (optional)
|
| 66 |
Parquet version of the same table (faster to load in many environments).
|
| 67 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 68 |
---
|
| 69 |
|
| 70 |
## Main Columns (schema overview)
|
| 71 |
|
| 72 |
Below is an overview of the most important columns you will encounter in `VaryNAndD_main.*`.
|
|
|
|
| 73 |
|
| 74 |
### Core design variables
|
| 75 |
|
| 76 |
- `treatment_effect` – Constant treatment effect used in the simulation (e.g., `0.1`).
|
| 77 |
- `SD_inherent` – Baseline SD of potential outcomes (`SD_inherent` in `GenerateCausalData`).
|
| 78 |
- `n_units` – Total number of experimental units.
|
| 79 |
+
- `k_covars` – Number of covariates.
|
| 80 |
+
- `prob_accept` – Target acceptance probability (`randomization_accept_prob`).
|
| 81 |
- `maxDraws` – Maximum number of candidate randomizations drawn (e.g., `1e5`, `2e5`).
|
| 82 |
- `findFI` – Logical (`TRUE`/`FALSE`): whether fiducial intervals were computed.
|
| 83 |
- `approximate_inv` – Logical (`TRUE`/`FALSE`): whether approximate inverse / stabilized linear algebra was used.
|
|
|
|
| 89 |
- `"BaseR"` (pure R baseline)
|
| 90 |
- `monte_i` – Monte Carlo replication index.
|
| 91 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 92 |
### Timing and hardware metadata
|
| 93 |
|
| 94 |
Timing quantities are used to produce the benchmark plots in the paper:
|
|
|
|
| 100 |
- `nCores` – Number of CPU cores from `benchmarkme::get_cpu()`.
|
| 101 |
- `cpuModel` – CPU model name from `benchmarkme::get_cpu()`.
|
| 102 |
|
|
|
|
|
|
|
| 103 |
---
|
| 104 |
|
| 105 |
## How to use the dataset
|
|
|
|
| 148 |
|
| 149 |
## Citation
|
| 150 |
|
| 151 |
+
If you use this dataset, please cite the paper:
|
| 152 |
|
| 153 |
```bibtex
|
| 154 |
@misc{goldstein2025fastrerandomizefastrerandomizationusing,
|