Random Sampling

Source: R/wrangling_issues.R

Generic function for drawing a random sample from an object.

For objects of class IssuesTB, this method returns a random subset of the issues.

sample(x, size, replace = FALSE, prob = NULL)

# S3 method for class 'IssuesTB'
sample(x, size = nrow(x), replace = FALSE, prob = NULL)

# Default S3 method
sample(x, size, replace = FALSE, prob = NULL)

Arguments

x

An object of class IssuesTB.

size

a non-negative integer giving the number of items to choose.

replace

should sampling be with replacement?

prob

a vector of probability weights for obtaining the elements of the vector being sampled.

Value

  • For IssuesTB objects, an object of the same class containing the sampled issues.

  • For all other objects, the result of base::sample().

Details

The arguments and overall behavior are consistent with base::sample(). For details about the sampling algorithm, probability weights, and special cases, refer to the original documentation: https://stat.ethz.ch/R-manual/R-devel/library/base/html/sample.html

See also

base::sample()

Examples

path <- system.file("data_issues", package = "IssueTrackeR")
open_issues <- get_issues(
    source = "local",
    dataset_dir = path,
    dataset_name = "open_issues.yaml"
)
#> Looking into open_issues.yaml ...
#> The issues will be read from /home/runner/work/_temp/Library/IssueTrackeR/data_issues/open_issues.yaml.
new_issues <- sample(open_issues, size = 5L)