accept_reject_psu: Accept or reject sampling units against population density of...

In ernestguevarra/surveysampler: Survey Sampling and Analysis Tools

Description

Accept or reject sampling units against population density of potential sampling units

Usage

accept_reject_psu(
  x,
  svy,
  psu = "psu",
  match = NULL,
  pop = "pop",
  verbose = TRUE,
  show_plot = TRUE,
  save_plot = FALSE
)

Arguments

x	A data.frame of all potential primary sampling units (PSUs) to sample from each uniquely identified and with corresponding populations.
svy	A data.frame of survey data drawn via probability proportional to population size (PPS) approach from all the potential PSUs in x.
psu	A single character value or vector of values corresponding to the variable name/s for the primary sampling unit in x and svy. Default is "psu".
match	A single character value corresponding to the variable name for the primary sampling unit in x that matches the primary sampling unit in svy. Default is NULL which indicates that primary sampling unit in x is the same as primary sampling unit in svy.
pop	A single character value corresponding to the variable name for the population figures in x. Default is "pop".
verbose	Logical. Should text of sample acceptance or rejection be printed/shown? Default to TRUE.
show_plot	Logical. Should plot of sample acceptance or rejection be shown? Default to TRUE.
save_plot	Logical. Should plot of sample acceptance or rejection be saved? Default to FALSE. If set to TRUE when show_plot is FALSE, no plot will be saved.

Value

A data.frame drawn from svy that contains the primary sampling units selected by the acceptance and rejection sampling.

Author(s)

Mark Myatt and Ernest Guevarra

Examples

accept_reject_psu(
  x = village_list,
  svy = sample_data,
  psu = c("id", "psu"),
  match = "cluster",
  pop = "population",
  verbose = FALSE,
  show_plot = FALSE
 )

ernestguevarra/surveysampler documentation built on Jan. 2, 2022, 4:25 a.m.