R: Draw a random sample

draw_rs {randomizr} | R Documentation

## Draw a random sample

### Description

You can either give draw_rs() an declaration, as created by `declare_rs` or you can specify the other arguments to describe a random sampling procedure.

### Usage

    draw_rs(declaration = NULL, N = NULL, strata = NULL, clusters = NULL,
      n = NULL, prob = NULL, strata_n = NULL, strata_prob = NULL,
      simple = FALSE, check_inputs = TRUE)

### Arguments

`declaration` | A random sampling declaration, created by `declare_rs`.
`N` | The number of units. N must be a positive integer. (required)
`strata` | A vector of length N that indicates which stratum each unit belongs to.
`clusters` | A vector of length N that indicates which cluster each unit belongs to.
`n` | Use for a design in which n units (or clusters) are sampled. In a stratified design, exactly n units in each stratum will be sampled. (optional)
`prob` | Use for a design in which either floor(N*prob) or ceiling(N*prob) units (or clusters) are sampled. The probability of being sampled is exactly prob because with probability 1-prob, floor(N*prob) units (or clusters) will be sampled and with probability prob, ceiling(N*prob) units (or clusters) will be sampled. prob must be a real number between 0 and 1 inclusive. (optional)
`strata_n` | Use for a design in which strata_n describes the number of units to sample within each stratum.
`strata_prob` | Use for a design in which strata_prob describes the probability of being sampled within each stratum. Differs from prob in that the probability of being sampled can vary across strata.
`simple` | logical, defaults to FALSE. If TRUE, simple random sampling is used. When `simple = TRUE`, please do not specify n or strata_n. When `simple = TRUE`, `prob` may vary by unit.
`check_inputs` | logical. Defaults to TRUE.

### Examples

    declaration <- declare_rs(N = 100, n = 30)
    S <- draw_rs(declaration = declaration)
    table(S)

    # equivalent to
    S <- draw_rs(N = 100, n = 30)
    table(S)

[Package randomizr version 0.16.1 Index]