DeclareDesign is a system for describing research designs in code and simulating them in order to understand their properties. Because DeclareDesign employs a consistent grammar of designs, you can focus on the intellectually challenging part – designing good research studies – without having to code up simulations from scratch.
To install the latest stable release of DeclareDesign, please ensure that you are running version 3.5 or later of R and run the following code:
Designs are declared by adding together design elements. Here’s a minimal example that describes a 100 unit randomized controlled trial with a binary outcome. Half the units are assigned to treatment and the remainder to control. The true value of the average treatment effect is 0.05 and it will be estimated with the difference-in-means estimator. The diagnosis shows that the study is unbiased but underpowered.
library(DeclareDesign) design <- declare_model( N = 100, potential_outcomes(Y ~ rbinom(N, size = 1, prob = 0.5 + 0.05 * Z)) ) + declare_inquiry(ATE = 0.05) + declare_assignment(Z = complete_ra(N, m = 50)) + declare_measurement(Y = reveal_outcomes(Y ~ Z)) + declare_estimator(Y ~ Z, model = lm_robust, inquiry = "ATE") diagnosands <- declare_diagnosands(bias = mean(estimate - estimand), power = mean(p.value <= 0.05)) diagnosis <- diagnose_design(design, diagnosands = diagnosands)
The core DeclareDesign package relies on four companion packages, each of which is useful in its own right.
To get started, have a look at this vignette on the idea behind DeclareDesign, which covers the main functionality of the software.
You can also browse a library of already declared designs, which relies on the
DesignLibrary package. The library includes canonical designs that you can download, modify, and deploy.
A fuller description of the philosophy underlying the software is described in this paper.
Each of these
declare_*() functions returns a function.
declare_model()(describes dimensions and distributions over the variables, including potential outcomes)
declare_inquiry()(takes variables in the model and calculates estimand value)
declare_sampling()(takes a population and selects a sample)
declare_assignment()(takes a population or sample and adds treatment assignments)
declare_measurement()(takes data and adds measured values)
declare_estimator()(takes data produced by sampling, assignment, and measurement and returns estimates linked to inquiries)
declare_test()(takes data produced by sampling, assignment, and measurement and returns the result of a test)
To declare a design, connect the components of your design with the + operator.
Once you have declared your design, there are four core post-design-declaration commands used to modify or diagnose your design:
diagnose_design()(takes a design and returns simulations and diagnosis)
draw_data()(takes a design and returns a single draw of the data)
draw_estimates()(takes a design and returns a single simulation of estimates)
draw_estimands()(takes a design and returns a single simulation of estimands)
A few other features:
N) and returns a design.
expand_design()is a function of a designer and parameters that return a design.