Package index

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

Summarize and inspect sampling results.

summary(<tbl_sample>)

Summarize a tbl_sample

frame_summary()

Summarize the population structure recorded with a sample

joint_expectation()

Compute pairwise joint expectations from a sample

design_effect() effective_n()

Design Effect and Effective Sample Size

varcomp()

Variance Components from an Executed Sample

Serialization

Save, share, and restore designs as JSON files.

write_design() read_design()

Write a sampling design to a file

design_json()

Convert a sampling design to JSON

replay_design()

Replay an execution receipt

as.list(<sampling_design>)

Convert Sampling Design to List

Helpers

Sorting and class checks.

serp()

Serpentine Sorting for Implicit Stratification

bound()

Controlled Count Bounds for Balanced Sampling

is_sampling_design()

Test if object is a sampling_design

is_tbl_sample()

Test if object is a tbl_sample

as_tbl_sample()

Coerce to a tbl_sample

get_design()

Get the design specification stored on a sample

get_stages_executed()

Get the executed stage numbers stored on a sample

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

bfa_eas_variance

Stratum Variances for Burkina Faso EAs

bfa_eas_cost

Stratum Costs for Burkina Faso EAs

zwe_eas

Zimbabwe Enumeration Areas for Demographic, Health, and Child-Indicator Surveys

ken_enterprises

Synthetic Kenya Establishment Frame