Skip to content

Sample from this expression

Description

Sample from this expression

Usage

<Expr>$sample(
  n = NULL,
  ...,
  fraction = NULL,
  with_replacement = FALSE,
  shuffle = FALSE,
  seed = NULL
)

Arguments

n Number of items to return. Cannot be used with fraction. Defaults to 1 if fraction is NULL.
These dots are for future extensions and must be empty.
fraction Fraction of items to return. Cannot be used with n.
with_replacement Allow values to be sampled more than once.
shuffle Shuffle the order of sampled data points.
seed Seed for the random number generator. If NULL (default), a random seed is generated for each sample operation.

Value

A polars expression

Examples

library("polars")

df <- pl$DataFrame(a = 1:3)
df$select(pl$col("a")$sample(
  fraction = 1, with_replacement = TRUE, seed = 1
))
#> shape: (3, 1)
#> ┌─────┐
#> │ a   │
#> │ --- │
#> │ i32 │
#> ╞═════╡
#> │ 3   │
#> │ 1   │
#> │ 1   │
#> └─────┘