Get and reset polars options

Description

polars_options() returns a list of options for polars. Options can be set with options(). Note that options must be prefixed with "polars.", e.g to modify the option to_r_vector.int64 you need to pass options(polars.to_r_vector.int64 =). See below for a description of all options.

polars_options_reset() brings all polars options back to their default value.

Usage

polars_options()

polars_options_reset()

Details

The following options are available (in alphabetical order, with the default value in parenthesis):

compat_level will affect as_nanoarrow_array_stream(\)’s polars_compat_level argument and \$sink_ipc()’s compat_level argument. See the documentation of those functions for details.
for all to_r_vector.\* options, see arguments of to_r_vector().
df_knitr_print (TODO: possible values??)

Value

polars_options() returns a named list where the names are option names and values are option values.

polars_options_reset() doesn’t return anything.

Examples

library("polars")


library(hms)
polars_options()

#> Options:
#> ========                                    
#> compat_level                  newest
#> df_knitr_print                  auto
#> to_r_vector.uint8            integer
#> to_r_vector.int64             double
#> to_r_vector.date                Date
#> to_r_vector.time                 hms
#> to_r_vector.struct         dataframe
#> to_r_vector.decimal           double
#> to_r_vector.as_clock_class     FALSE
#> to_r_vector.ambiguous          raise
#> to_r_vector.non_existent       raise
#> 
#> See `?polars_options` for the definition of all options.

withr::with_options(
  list(polars.to_r_vector.int64 = "character"),
  polars_options()
)

#> Options:
#> ========                                    
#> compat_level                  newest
#> df_knitr_print                  auto
#> to_r_vector.uint8            integer
#> to_r_vector.int64          character
#> to_r_vector.date                Date
#> to_r_vector.time                 hms
#> to_r_vector.struct         dataframe
#> to_r_vector.decimal           double
#> to_r_vector.as_clock_class     FALSE
#> to_r_vector.ambiguous          raise
#> to_r_vector.non_existent       raise
#> 
#> See `?polars_options` for the definition of all options.