All sampling functions in sondage return objects inheriting from class
"sondage_sample". These objects store the realized sample together with
the design-defining quantities needed by the query generics.
Details
All sondage_sample objects contain:
$sampleSample indices (integer vector, or matrix/list when
nrep > 1).$nSample size. For designs with
$fixed_size = TRUE, an integer equal to the realized sample size. For random-size designs ($fixed_size = FALSE), a double equal to the expected sample size –sum(pik)for"poisson", the user-supplied target for"bernoulli".$NPopulation size.
$methodSampling method name.
$fixed_sizeWhether the sample size is fixed by design.
Without-replacement ("wor") objects also contain:
$pikInclusion probability vector. For most methods this equals the true first-order probabilities. For
"sps"and"pareto", this is the target vector.
With-replacement ("wr") objects also contain:
$probPer-draw selection probability vector.
$hitsRealized selection counts (integer vector, or
N x nrepmatrix whennrep > 1).
The class vector records the design family:
c("equal_prob", "wor", "sondage_sample")Equal probability, without replacement.
c("equal_prob", "wr", "sondage_sample")Equal probability, with replacement.
c("unequal_prob", "wor", "sondage_sample")Unequal probability, without replacement.
c("balanced", "unequal_prob", "wor", "sondage_sample")Balanced sampling (cube method); dispatches to
unequal_prob/wormethods unless abalanced-specific method is defined.c("unequal_prob", "wr", "sondage_sample")Unequal probability, with replacement.