Skip to contents

Design Specification

Build a sampling design step by step.

sampling_design()
Create a Sampling Design
stratify_by()
Define Stratification
cluster_by()
Define Sampling Units (Clusters)
draw()
Specify Selection Parameters
add_stage()
Define a New Stage in Multi-Stage Designs

Execution

Execute designs and validate frames.

execute()
Execute a Sampling Design
validate_frame()
Validate a Frame Against a Design

Survey Export

Convert samples to survey/srvyr objects for analysis.

as_svydesign()
Convert a tbl_sample to a survey design object
as_svrepdesign()
Convert a tbl_sample to a replicate-weight survey design
as_survey_design(<tbl_sample>)
Convert a tbl_sample to a srvyr tbl_svy object
as_survey_rep(<tbl_sample>)
Convert a tbl_sample to a srvyr replicate-weight tbl_svy object

Diagnostics

Summarise and inspect sampling results.

summary(<tbl_sample>)
Summarise a tbl_sample
joint_expectation()
Compute pairwise joint expectations from a sample and its frame
design_effect() effective_n()
Design Effect and Effective Sample Size

Helpers

Sorting, class checks, and serialization.

serp()
Serpentine Sorting for Implicit Stratification
is_sampling_design()
Test if object is a sampling_design
is_tbl_sample()
Test if object is a tbl_sample
get_design()
Get design from a sample
get_stages_executed()
Get executed stages from a sample
as.list(<sampling_design>)
Convert Sampling Design to List
print(<sampling_design>) tbl_sum(<tbl_sample>)
Print Methods for samplyr Objects
`[`(<tbl_sample>)
Subset a tbl_sample preserving class

Datasets

Synthetic survey frames for examples.

samplyr-datasets
Sampling Frames
bfa_eas
Burkina Faso Enumeration Areas (LSMS-style)
bfa_eas_variance
Stratum Variances for Burkina Faso EAs
bfa_eas_cost
Stratum Costs for Burkina Faso EAs
zwe_eas
Zimbabwe Enumeration Areas (DHS Two-Stage Cluster)
zwe_households
Zimbabwe Households (Two-Phase Subframe)
ken_enterprises
Kenya Enterprises (Enterprise Survey with Panels and PRN)