Package index

Declare

The steps of a design, joined with +.

declare_model()

Declare the data-generating model

declare_inquiry() declare_inquiries() declare_estimand() declare_estimands()

Declare an inquiry

declare_sampling()

Declare a sampling procedure

declare_assignment()

Declare an assignment procedure

declare_measurement()

Declare measurement

declare_estimator()

Declare an estimator

declare_test()

Declare a hypothesis test

declare_step()

Declare a custom data-handling step

declare_parameters()

Declare the parameters of a design

declare_notes()

Declare quantities computed while a design runs

`+`(<dd>)

Combine design steps into a design

Helpers

Functions used inside a declaration rather than as a step of it.

label_estimator() label_test()

Wrap a custom function as a labeled estimator

tidy_try()

Tidy a model fit, with a fallback

vars()

Capture variables as quosures

Draw and run

Run a declared design once.

draw_data()

Draw the realized data from a design

draw_estimands() draw_estimand()

Draw the realized estimands

draw_estimates()

Draw the realized estimates

get_estimates()

Get estimates for a fixed dataset

run_design()

Execute a design end-to-end

Diagnose

Run a design many times and summarize how it performs.

diagnose_design() diagnose_designs()

Diagnose a design

simulate_design() simulate_designs()

Simulate one or more designs

diagnose_simulations()

Diagnose a precomputed simulations table

declare_diagnosands()

Declare diagnosands

select_diagnosands()

Build a diagnosands step from a set of named diagnosands

default_diagnosands()

Default diagnosands

get_diagnosands()

Get the diagnosands table from a diagnosis

get_simulations()

Get the simulations table from a diagnosis

compare_diagnoses()

Compare the diagnosands of two designs

tidy(<diagnosis>)

Tidy a diagnosis

pop.var()

Population variance

Redesign

Change the parameters of a declared design.

redesign()

Redesign

design_parameters()

Report the parameters a design can be redesigned on

design_notes()

Report the notes a design takes

Inspect

Print and summarize designs and diagnoses.

print(<design>)

Print a design

summary(<design>)

Summarize a design

print(<design_step>)

Print a design step

print(<diagnosis>)

Print a diagnosis

summary(<diagnosis>)

Summarize a diagnosis

format(<diagnosis>) reshape_diagnosis()

Format a diagnosis for display

print(<compared_diagnoses>)

Print a diagnosand comparison

print(<objects>)

Print the objects table, one row per name

Cite

Attach a citation to a design and retrieve it.

set_citation()

Attach a citation to a design

cite_design()

Retrieve a design's citation

Deprecated and defunct

1.x functions kept for porting, each pointing at its replacement.

insert_step()

Insert a step into a design (deprecated)

delete_step()

Delete a step from a design (deprecated)

replace_step()

Replace a step in a design (deprecated)

expand_design()

Build a family of designs from a designer function (deprecated)

set_diagnosands()

Attach diagnosands to a design (deprecated)

declare_population()

Deprecated alias for declare_model()

model_handler() tidy_estimator()

Deprecated alias for label_estimator()

declare_potential_outcomes() declare_reveal()

Defunct step declarations from DeclareDesign 1.x

compare_designs() compare_design_code() compare_design_data() compare_design_estimates() compare_design_inquiries() compare_design_summaries() print_code()

Defunct comparison helpers

Package

DeclareDesign DeclareDesign-package

DeclareDesign: A Tidyverse-First Research Design Declaration and Diagnosis Tool