Sample from this DataFrame

Description

Usage

<DataFrame>$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 DataFrame

Examples

library("polars")

df <- pl$DataFrame(
  foo = 1:3,
  bar = 6:8,
  ham = c("a", "b", "c")
)
df$sample(n = 2, seed = 0)

#> shape: (2, 3)
#> ┌─────┬─────┬─────┐
#> │ foo ┆ bar ┆ ham │
#> │ --- ┆ --- ┆ --- │
#> │ i32 ┆ i32 ┆ str │
#> ╞═════╪═════╪═════╡
#> │ 3   ┆ 8   ┆ c   │
#> │ 2   ┆ 7   ┆ b   │
#> └─────┴─────┴─────┘