Package: polars 0.20.0

Soren Welling

polars: Lightning-Fast 'DataFrame' Library

Lightning-fast 'DataFrame' library written in 'Rust'. Convert R data to 'Polars' data and vice versa. Perform fast, lazy, larger-than-memory and optimized data queries. 'Polars' is interoperable with the package 'arrow', as both are based on the 'Apache Arrow' Columnar Format.

Authors:Ritchie Vink [aut], Soren Welling [aut, cre], Tatsuya Shima [aut], Etienne Bacher [aut]

polars_0.20.0.tar.gz
polars_0.20.0.zip(r-4.5)polars_0.20.0.zip(r-4.4)polars_0.20.0.zip(r-4.3)
polars_0.20.0.tgz(r-4.4-x86_64)polars_0.20.0.tgz(r-4.4-arm64)polars_0.20.0.tgz(r-4.3-x86_64)polars_0.20.0.tgz(r-4.3-arm64)
polars_0.20.0.tar.gz(r-4.5-noble)polars_0.20.0.tar.gz(r-4.4-noble)
polars.pdf |polars.html
polars/json (API)
NEWS

# Install 'polars' in R:
install.packages('polars', repos = c('https://r-multiverse.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/pola-rs/r-polars/issues

On CRAN:

arrowpolarsrust

11.96 score 470 stars 2 packages 1.0k scripts 10 downloads 15 exports 1 dependencies

Last updated 18 days agofrom:4bd16001d9 (on v0.20.0). Checks:OK: 8 WARNING: 1. Indexed: no.

TargetResultDate
Doc / VignettesOKOct 16 2024
R-4.5-win-x86_64WARNINGOct 16 2024
R-4.5-linux-x86_64OKOct 16 2024
R-4.4-win-x86_64OKOct 16 2024
R-4.4-mac-x86_64OKOct 16 2024
R-4.4-mac-aarch64OKOct 16 2024
R-4.3-win-x86_64OKOct 16 2024
R-4.3-mac-x86_64OKOct 16 2024
R-4.3-mac-aarch64OKOct 16 2024

Exports:.pras_polars_dfas_polars_lfas_polars_seriesis_polars_dfis_polars_dtypeis_polars_lfis_polars_seriesplpolars_code_completion_activatepolars_code_completion_deactivatepolars_envvarspolars_infopolars_optionspolars_options_reset

Dependencies:codetools

An Introduction to Polars from R

Rendered frompolars.Rmdusingknitr::rmarkdownon Oct 16 2024.

Last update: 2024-08-14
Started: 2023-04-13

Differences with Python Polars

Rendered fromdifferences-with-python.Rmdusingknitr::rmarkdownon Oct 16 2024.

Last update: 2024-04-11
Started: 2024-04-11

Installation details

Rendered frominstall.Rmdusingknitr::rmarkdownon Oct 16 2024.

Last update: 2024-07-05
Started: 2024-01-02

Optimize polars performance

Rendered fromperformance.Rmdusingknitr::rmarkdownon Oct 16 2024.

Last update: 2024-08-14
Started: 2023-09-09

Polars - User Guide for R

Rendered fromuserguide.Rmdusingknitr::rmarkdownon Oct 16 2024.

Last update: 2024-07-01
Started: 2023-04-29

Readme and manuals

Help Manual

Help pageTopics
Extract Parts of a Polars Object[.RPolarsDataFrame [.RPolarsLazyFrame [.RPolarsSeries
Create a arrow Table from a Polars objectas_arrow_table.RPolarsDataFrame
Create a nanoarrow_array_stream from a Polars objectas_nanoarrow_array_stream.RPolarsDataFrame as_nanoarrow_array_stream.RPolarsSeries
To polars DataFrameas_polars_df as_polars_df.ArrowTabular as_polars_df.data.frame as_polars_df.default as_polars_df.nanoarrow_array as_polars_df.nanoarrow_array_stream as_polars_df.RecordBatchReader as_polars_df.RPolarsDataFrame as_polars_df.RPolarsDynamicGroupBy as_polars_df.RPolarsGroupBy as_polars_df.RPolarsLazyFrame as_polars_df.RPolarsLazyGroupBy as_polars_df.RPolarsRollingGroupBy as_polars_df.RPolarsSeries
To polars LazyFrameas_polars_lf as_polars_lf.default as_polars_lf.RPolarsLazyFrame as_polars_lf.RPolarsLazyGroupBy
To polars Seriesas_polars_series as_polars_series.Array as_polars_series.ChunkedArray as_polars_series.clock_sys_time as_polars_series.clock_time_point as_polars_series.clock_zoned_time as_polars_series.data.frame as_polars_series.default as_polars_series.list as_polars_series.nanoarrow_array as_polars_series.nanoarrow_array_stream as_polars_series.POSIXlt as_polars_series.RecordBatchReader as_polars_series.RPolarsChainedThen as_polars_series.RPolarsExpr as_polars_series.RPolarsSeries as_polars_series.RPolarsThen as_polars_series.vctrs_rcrd
Create a arrow RecordBatchReader from a Polars objectas_record_batch_reader.RPolarsDataFrame
Convert to a character vectoras.character.RPolarsSeries
Convert to a data.frameas.data.frame.RPolarsDataFrame as.data.frame.RPolarsLazyFrame
Convert to a matrixas.matrix.RPolarsDataFrame as.matrix.RPolarsLazyFrame
Convert to a vectoras.vector.RPolarsSeries
Combine to a Seriesc.RPolarsSeries
Cast DataFrame column(s) to the specified dtypeDataFrame_cast
Inner workings of the DataFrame-classDataFrame_class RPolarsDataFrame
Create an empty or n-row null-filled copy of the DataFrameDataFrame_clear
Clone a DataFrameDataFrame_clone
Summary statistics for a DataFrameDataFrame_describe
Drop columns of a DataFrameDataFrame_drop
Drop in placeDataFrame_drop_in_place
Drop nulls (missing values)DataFrame_drop_nulls
Data types informationDataFrame_dtype_strings
Compare two DataFramesDataFrame_equals
Estimated sizeDataFrame_estimated_size
Explode columns containing a list of valuesDataFrame_explode
Fill floating point NaN value with a fill valueDataFrame_fill_nan
Fill nullsDataFrame_fill_null
Filter rows of a DataFrameDataFrame_filter
Get the first row of the DataFrame.DataFrame_first
Take every nth row in the DataFrameDataFrame_gather_every
Get column (as one Series)DataFrame_get_column
Get the DataFrame as a List of SeriesDataFrame_get_columns
Show a dense preview of the DataFrameDataFrame_glimpse
Group a DataFrameDataFrame_group_by
Group based on a date/time or integer columnDataFrame_group_by_dynamic
Get the first 'n' rows.DataFrame_head DataFrame_limit
Return the element at the given row/column.DataFrame_item
Join DataFramesDataFrame_join
Perform joins on nearest keysDataFrame_join_asof
Perform a join based on one or multiple (in)equality predicatesDataFrame_join_where
Get the last row of the DataFrame.DataFrame_last
Convert an existing DataFrame to a LazyFrameDataFrame_lazy lazy
MaxDataFrame_max
MeanDataFrame_mean
MedianDataFrame_median
MinDataFrame_min
Number of chunks of the Series in a DataFrameDataFrame_n_chunks
Count null valuesDataFrame_null_count
Split a DataFrame into multiple DataFramesDataFrame_partition_by
Pivot data from long to wideDataFrame_pivot
QuantileDataFrame_quantile
Rechunk a DataFrameDataFrame_rechunk
Rename column names of a DataFrameDataFrame_rename
ReverseDataFrame_reverse
Create rolling groups based on a date/time or integer columnDataFrame_rolling
Take a sample of rows from a DataFrameDataFrame_sample
Select and modify columns of a DataFrameDataFrame_select select
Select and modify columns of a DataFrameDataFrame_select_seq
Shift a DataFrameDataFrame_shift
SliceDataFrame_slice
Sort a DataFrameDataFrame_sort
Execute a SQL query against the DataFrameDataFrame_sql
StdDataFrame_std
SumDataFrame_sum
Get the last 'n' rows.DataFrame_tail
Return Polars DataFrame as R data.frameDataFrame_to_data_frame
Convert variables into dummy/indicator variablesDataFrame_to_dummies
Return Polars DataFrame as a list of vectorsDataFrame_to_list
Write Arrow IPC data to a raw vectorDataFrame_to_raw_ipc
Get column by indexDataFrame_to_series
Convert DataFrame to a Series of type "struct"DataFrame_to_struct to_struct
Transpose a DataFrame over the diagonal.DataFrame_transpose
Drop duplicated rowsDataFrame_unique
Unnest the Struct columns of a DataFrameDataFrame_unnest
Unpivot a Frame from wide to long formatDataFrame_unpivot
VarDataFrame_var
Modify/append column(s)DataFrame_with_columns with_columns
Modify/append column(s)DataFrame_with_columns_seq
Add a column for row indicesDataFrame_with_row_index
Write to comma-separated values (CSV) fileDataFrame_write_csv
Write to Arrow IPC file (a.k.a Feather file)DataFrame_write_ipc
Write to JSON fileDataFrame_write_json
Write to NDJSON fileDataFrame_write_ndjson
Write to parquet fileDataFrame_write_parquet
Create Array DataTypeDataType_Array
Create Categorical DataTypeDataType_Categorical
Check whether the data type contains categoricalsDataType_contains_categoricals
Check whether the data type contains viewsDataType_contains_views
Data type representing a calendar date and time of day.DataType_Datetime pl_Datetime
Data type representing a time durationDataType_Duration
Create Enum DataTypeDataType_Enum
Check whether the data type is an array typeDataType_is_array
Check whether the data type is a binary typeDataType_is_binary
Check whether the data type is a boolean typeDataType_is_bool
Check whether the data type is a Categorical typeDataType_is_categorical
Check whether the data type is an Enum typeDataType_is_enum
Check whether the data type is a float typeDataType_is_float
Check whether the data type is an integer typeDataType_is_integer
Check whether the data type is knownDataType_is_known
Check whether the data type is a list typeDataType_is_list
Check whether the data type is a logical typeDataType_is_logical
Check whether the data type is a nested typeDataType_is_nested
Check whether the data type is a null typeDataType_is_null
Check whether the data type is a numeric typeDataType_is_numeric
Check whether the data type is an ordinal typeDataType_is_ord
Check whether the data type is a primitive typeDataType_is_primitive
Check whether the data type is a signed integer typeDataType_is_signed_integer
Check whether the data type is a String typeDataType_is_string
Check whether the data type is a temporal typeDataType_is_struct
Check whether the data type is a temporal typeDataType_is_temporal
Check whether the data type is an unsigned integer typeDataType_is_unsigned_integer
Create List DataTypeDataType_List
Create Struct DataTypeDataType_Struct
Get the dimensionsdim.RPolarsDataFrame dim.RPolarsLazyFrame
Get the row and column namesdimnames.RPolarsDataFrame dimnames.RPolarsLazyFrame
Translation definitions across python, R and polars.docs_translations
Aggregate over a DynamicGroupByDynamicGroupBy_agg
Operations on Polars DataFrame grouped on time or integer valuesDynamicGroupBy_class RPolarsDynamicGroupBy
Ungroup a DynamicGroupBy objectDynamicGroupBy_ungroup
Compute the absolute valuesExpr_abs
Add two expressionsExpr_add
Aggregate groupsExpr_agg_groups
Rename Expr outputExpr_alias
Apply logical AND on a columnExpr_all
Apply logical AND on two expressionsExpr_and
Apply logical OR on a columnExpr_any
Append expressionsExpr_append
Approx count unique valuesExpr_approx_n_unique
Compute inverse cosineExpr_arccos
Compute inverse hyperbolic cosineExpr_arccosh
Compute inverse sineExpr_arcsin
Compute inverse hyperbolic sineExpr_arcsinh
Compute inverse tangentExpr_arctan
Compute inverse hyperbolic tangentExpr_arctanh
Index of max valueExpr_arg_max
Index of min valueExpr_arg_min
Index of a sortExpr_arg_sort
Index of first unique valuesarg_unique Expr_arg_unique
Fill null values backwardExpr_backward_fill
Bottom k valuesExpr_bottom_k
Cast between DataTypeExpr_cast
CeilingExpr_ceil
Polars ExpressionsExpr_class RPolarsExpr
Clip elementsExpr_clip
Compute cosineExpr_cos
Compute hyperbolic cosineExpr_cosh
Count elementsExpr_count Expr_len
Cumulative countExpr_cum_count
Cumulative maximumExpr_cum_max
Cumulative minimumExpr_cum_min
Cumulative productExpr_cum_prod
Cumulative sumExpr_cum_sum
Cumulative evaluation of expressionsExpr_cumulative_eval
Bin continuous values into discrete categoriesExpr_cut
DifferenceExpr_diff
Divide two expressionsExpr_div
Dot productExpr_dot
Drop NaNExpr_drop_nans
Drop missing valuesExpr_drop_nulls
EntropyExpr_entropy
Check equalityExpr_eq
Check equality without 'null' propagationExpr_eq_missing
Exponentially-weighted moving averageExpr_ewm_mean
Exponentially-weighted moving standard deviationExpr_ewm_std
Exponentially-weighted moving varianceExpr_ewm_var
Exclude certain columns from selectionexclude Expr_exclude
Compute the exponential of the elementsExpr_exp
Explode a list or String SeriesExpr_explode
Extend Series with a constantExpr_extend_constant
Fill floating point NaN value with a fill valueExpr_fill_nan
Fill null values with a value or strategyExpr_fill_null
Filter a single column.Expr_filter
Get the first value.Expr_first
Explode a list or String SeriesExpr_flatten
FloorExpr_floor
Floor divide two expressionsExpr_floor_div
Fill null values forwardExpr_forward_fill
Gather values by indexExpr_gather
Gather every nth elementExpr_gather_every
Check strictly greater inequalityExpr_gt
Check greater or equal inequalityExpr_gt_eq
Check whether the expression contains one or more null valuesExpr_has_nulls
Hash elementsExpr_hash hash
Get the first n elementsExpr_head
Wrap column in listExpr_implode
Inspect evaluated SeriesExpr_inspect
Interpolate null valuesExpr_interpolate
Check if an expression is between the given lower and upper boundsExpr_is_between
Check whether each value is duplicatedExpr_is_duplicated
Check if elements are finiteExpr_is_finite
Check whether each value is the first occurrenceExpr_is_first_distinct
Check whether a value is in a vectorExpr_is_in
Check if elements are infiniteExpr_is_infinite is_infinite
Check whether each value is the last occurrenceExpr_is_last_distinct
Check if elements are NaNExpr_is_nan is_nan
Check if elements are not NaNExpr_is_not_nan is_not_nan
Check if elements are not NULLExpr_is_not_null
Check if elements are NULLExpr_is_null
Check whether each value is uniqueExpr_is_unique
KurtosisExpr_kurtosis
Get the last valueExpr_last
Get the first n elementsExpr_limit
Compute the logarithm of elementsExpr_log
Compute the base-10 logarithm of elementsExpr_log10
Find the lower bound of a DataTypeExpr_lower_bound
Check strictly lower inequalityExpr_lt
Check lower or equal inequalityExpr_lt_eq
Map an expression with an R functionExpr_map_batches
Map a custom/user-defined function (UDF) to each element of a columnExpr_map_elements
Get maximum valueExpr_max
Get mean valueExpr_mean
Get median valueExpr_median
Get minimum valueExpr_min
Modulo two expressionsExpr_mod
ModeExpr_mode
Multiply two expressionsExpr_mul
Count number of unique valuesExpr_n_unique
Get maximum value with NaNExpr_nan_max
Get minimum value with NaNExpr_nan_min
Check inequalityExpr_neq
Check inequality without 'null' propagationExpr_neq_missing
Negate a boolean expressionExpr_not
Count missing valuesExpr_null_count
Apply logical OR on two expressionsExpr_or
Compute expressions over the given groupsExpr_over
Percentage changeExpr_pct_change
Find local maximaExpr_peak_max
Find local minimaExpr_peak_min
Exponentiation two expressionsExpr_pow
ProductExpr_product
Bin continuous values into discrete categories based on their quantilesExpr_qcut
Get quantile value.Expr_quantile
Rank elementsExpr_rank
Rechunk memory layoutExpr_rechunk
Reinterpret bitsExpr_reinterpret
Repeat a SeriesExpr_rep
Repeat valuesExpr_repeat_by
Replace the given values by different values of the same data type.Expr_replace
Replace all values by different values.Expr_replace_strict
Reshape this Expr to a flat Series or a Series of ListsExpr_reshape
Reverse a variableExpr_reverse
Get the lengths of runs of identical valuesExpr_rle
Map values to run IDsExpr_rle_id
Create rolling groups based on a time or numeric columnExpr_rolling
Rolling maximumExpr_rolling_max
Apply a rolling max based on another column.Expr_rolling_max_by
Rolling meanExpr_rolling_mean
Apply a rolling mean based on another column.Expr_rolling_mean_by
Rolling medianExpr_rolling_median
Apply a rolling median based on another column.Expr_rolling_median_by
Rolling minimumExpr_rolling_min
Apply a rolling min based on another column.Expr_rolling_min_by
Rolling quantileExpr_rolling_quantile
Compute a rolling quantile based on another columnExpr_rolling_quantile_by
Rolling skewExpr_rolling_skew
Rolling standard deviationExpr_rolling_std
Compute a rolling standard deviation based on another columnExpr_rolling_std_by
Rolling sumExpr_rolling_sum
Apply a rolling sum based on another column.Expr_rolling_sum_by
Rolling varianceExpr_rolling_var
Compute a rolling variance based on another columnExpr_rolling_var_by
RoundExpr_round
Take a sampleExpr_sample
Where to inject element(s) to maintain sortingExpr_search_sorted
Flag an Expr as "sorted"Expr_set_sorted
Shift values by the given number of indicesExpr_shift
Shrink numeric columns to the minimal required datatypeExpr_shrink_dtype
Shuffle valuesExpr_shuffle
Get the sign of elementsExpr_sign
Compute sineExpr_sin
Compute hyperbolic sineExpr_sinh
SkewnessExpr_skew
Get a slice of an ExprExpr_slice
Sort an ExprExpr_sort
Sort Expr by order of othersExpr_sort_by
Compute the square root of the elementsExpr_sqrt
Get standard deviationExpr_std
Substract two expressionsExpr_sub
Get sum valueExpr_sum
Get the last n elementsExpr_tail
Compute tangentExpr_tan
Compute hyperbolic tangentExpr_tanh
Cast an Expr to its physical representationExpr_to_physical to_physical
Convert an Expr to R outputExpr_to_r
Convert Literal to SeriesExpr_to_series
Top k valuesExpr_top_k
Get unique valuesExpr_unique
Count unique valuesExpr_unique_counts
Find the upper bound of a DataTypeExpr_upper_bound
Value countsExpr_value_counts
Get varianceExpr_var
Make a when-then-otherwise expressionChainedThen ChainedThen_otherwise ChainedThen_when ChainedWhen ChainedWhen_then Expr_when_then_otherwise otherwise pl_when RPolarsChainedThen RPolarsChainedWhen RPolarsThen RPolarsWhen Then then Then_otherwise Then_when When when When_then
Apply logical XOR on two expressionsExpr_xor
Evaluate whether all boolean values in an array are trueExprArr_all
Evaluate whether any boolean values in an array are trueExprArr_any
Get the index of the maximal value in an arrayExprArr_arg_max
Get the index of the minimal value in an arrayExprArr_arg_min
Check if array contains a given valueExprArr_contains
Get the value by index in an arrayExprArr_get
Join elements of an arrayExprArr_join
Find the maximum value in an arrayExprArr_max
Find the median in an arrayExprArr_median
Find the minimum value in an arrayExprArr_min
Reverse values in an arrayExprArr_reverse
Shift array values by 'n' indicesExprArr_shift
Sort values in an arrayExprArr_sort
Find the standard deviation in an arrayExprArr_std
Sum all elements in an arrayExprArr_sum
Convert an Array column into a List column with the same inner data typeExprArr_to_list
Convert array to structExprArr_to_struct
Get unique values in an arrayExprArr_unique
Find the variance in an arrayExprArr_var
Check if binaries contain a binary substringExprBin_contains
Decode values using the provided encodingExprBin_decode
Encode a value using the provided encodingExprBin_encode
Check if string values end with a binary substringExprBin_ends_with
Get the size of binary values in the given unitExprBin_size
Check if values start with a binary substringExprBin_starts_with
Get the categories stored in this data typeExprCat_get_categories
Set OrderingExprCat_set_ordering
cast_time_unit(Expr)$dt$cast_time_unit ExprDT_cast_time_unit
Combine Date and TimeExprDT_combine
Convert to given time zone for an expression of type Datetime.ExprDT_convert_time_zone
Day(Expr)$dt$day ExprDT_day
EpochExprDT_epoch
Hour(Expr)$dt$hour ExprDT_hour
Determine whether the year of the underlying date is a leap yearExprDT_is_leap_year
Iso-Year(Expr)$dt$iso_year ExprDT_iso_year
Extract microseconds from underlying Datetime representation.ExprDT_microsecond
Extract milliseconds from underlying Datetime representationExprDT_millisecond
Minute(Expr)$dt$minute ExprDT_minute
Month(Expr)$dtmonth ExprDT_month
Extract nanoseconds from underlying Datetime representationExprDT_nanosecond
Offset By(Expr)$dt$offset_by ExprDT_offset_by
Ordinal Day(Expr)$dt$ordinal_day ExprDT_ordinal_day
Quarter(Expr)$dt$quarter ExprDT_quarter
Replace time zone(Expr)$dt$replace_time_zone ExprDT_replace_time_zone
Round datetimeExprDT_round
Extract seconds from underlying Datetime representationExprDT_second
strftime(Expr)$dt$strftime ExprDT_strftime
Extract time from a Datetime SeriesExprDT_time
timestamp(Expr)$dt$timestamp ExprDT_timestamp
DaysExprDT_total_days
HoursExprDT_total_hours
microsecondsExprDT_total_microseconds
millisecondsExprDT_total_milliseconds
MinutesExprDT_total_minutes
nanosecondsExprDT_total_nanoseconds
SecondsExprDT_total_seconds
Truncate datetimeExprDT_truncate
Week(Expr)$dt$week ExprDT_week
Weekday(Expr)$dt$weekday ExprDT_weekday
with_time_unit(Expr)$dt$with_time_unit ExprDT_with_time_unit
Year(Expr)$dt$year ExprDT_year
Evaluate whether all boolean values in a list are trueExprList_all
Evaluate whether any boolean values in a list are trueExprList_any
Get the index of the maximal value in listExprList_arg_max
Get the index of the minimal value in listExprList_arg_min
Concat two list variablesExprList_concat
Check if list contains a given valueExprList_contains
Compute difference between list valuesExprList_diff
Run any polars expression on the list valuesExprList_eval
Returns a column with a separate row for every list elementExprList_explode
Get the first value in a listExprList_first
Get several values by index in a listExprList_gather
Gather every nth element in a listExprList_gather_every
Get the value by index in a listExprList_get
Get the first 'n' values of a listExprList_head
Join elements of a listExprList_join
Get the last value in a listExprList_last
Get the length of each listExprList_len
Find the maximum value in a listExprList_max
Compute the mean value of a listExprList_mean
Find the minimum value in a listExprList_min
Get the number of unique values in a listExprList_n_unique
Reverse values in a listExprList_reverse
Sample from this listExprList_sample
Get the difference of two list variablesExprList_set_difference
Get the intersection of two list variablesExprList_set_intersection
Get the symmetric difference of two list variablesExprList_set_symmetric_difference
Get the union of two list variablesExprList_set_union
Shift list values by 'n' indicesExprList_shift
Slice listExprList_slice
Sort values in a listExprList_sort
Sum all elements in a listExprList_sum
Get the last 'n' values of a listExprList_tail
Convert a Series of type 'List' to 'Struct'ExprList_to_struct
Get unique values in a listExprList_unique
Check if two expressions are equivalentExprMeta_eq
Indicate if an expression has multiple outputsExprMeta_has_multiple_outputs
Indicate if an expression uses a regex projectionExprMeta_is_regex_projection
Check if two expressions are differentExprMeta_neq
Get the column name that this expression would produceExprMeta_output_name
PopExprMeta_pop
Get the root column namesExprMeta_root_names
Format an expression as a treeExprMeta_tree_format
Undo any renaming operationExprMeta_undo_aliases
Keep the original root name of the expression.ExprName_keep
Add a prefix to a column nameExprName_prefix
Add a prefix to all fields name of a structExprName_prefix_fields
Add a suffix to a column nameExprName_suffix
Add a suffix to all fields name of a structExprName_suffix_fields
Make the root column name lowercaseExprName_to_lowercase
Make the root column name uppercaseExprName_to_uppercase
Check if string contains a substring that matches a patternExprStr_contains
Use the aho-corasick algorithm to find matchesExprStr_contains_any
Count all successive non-overlapping regex matchesExprStr_count_matches
Decode a value using the provided encodingExprStr_decode
Encode a value using the provided encodingExprStr_encode
Check if string ends with a regexExprStr_ends_with
Extract the target capture group from provided patternsExprStr_extract
Extract all matches for the given regex patternExprStr_extract_all
Extract all capture groups for the given regex patternExprStr_extract_groups
Use the aho-corasick algorithm to extract matchesExprStr_extract_many
Return the index position of the first substring matching a patternExprStr_find
Return the first n characters of each stringExprStr_head
Vertically concatenate the string values in the column to a single string value.ExprStr_join
Parse string values as JSON.ExprStr_json_decode
Extract the first match of JSON string with the provided JSONPath expressionExprStr_json_path_match
Get the number of bytes in stringsExprStr_len_bytes
Get the number of characters in stringsExprStr_len_chars
Left justify stringsExprStr_pad_end
Right justify stringsExprStr_pad_start
Replace first matching regex/literal substring with a new string valueExprStr_replace
Replace all matching regex/literal substrings with a new string valueExprStr_replace_all
Use the aho-corasick algorithm to replace many matchesExprStr_replace_many
Returns string values in reversed orderExprStr_reverse
Create subslices of the string values of a String SeriesExprStr_slice
Split the string by a substringExprStr_split
Split the string by a substring using 'n' splitsExprStr_split_exact
Split the string by a substring, restricted to returning at most 'n' itemsExprStr_splitn
Check if string starts with a regexExprStr_starts_with
Strip leading and trailing charactersExprStr_strip_chars expr_str_strip_chars
Strip trailing charactersExprStr_strip_chars_end expr_str_strip_chars_end
Strip leading charactersExprStr_strip_chars_start expr_str_strip_chars_start
Convert a String column into a Date/Datetime/Time column.ExprStr_strptime
Return the last n characters of each stringExprStr_tail
Convert a String column into a Date columnExprStr_to_date
Convert a String column into a Datetime columnExprStr_to_datetime
Convert a String column into an Int64 column with base radixExprStr_to_integer
Convert a string to lowercaseExprStr_to_lowercase
Convert a String column into a Time columnExprStr_to_time
Convert a string to titlecaseExprStr_to_titlecase
Convert a string to uppercaseExprStr_to_uppercase
Fills the string with zeroes.ExprStr_zfill expr_str_zfill
Retrieve one of the fields of this Struct as a new SeriesExprStruct_field
Rename the fields of the structExprStruct_rename_fields
Add or overwrite fields of this structExprStruct_with_fields
Get/set global R session pool capacity (DEPRECATED)global_rpool_cap pl_get_global_rpool_cap pl_set_global_rpool_cap set_global_rpool_cap
Aggregate over a GroupByagg GroupBy_agg
Operations on Polars grouped DataFrameGroupBy_class RPolarsGroupBy
GroupBy FirstGroupBy_first
GroupBy LastGroupBy_last
GroupBy MaxGroupBy_max
GroupBy MeanGroupBy_mean
GroupBy MedianGroupBy_median
GroupBy MinGroupBy_min
GroupBy null countGroupBy_null_count
QuantileGroupBy_quantile
Shift the values by a given periodGroupBy_shift
GroupBy StdGroupBy_std
GroupBy SumGroupBy_sum
GroupBy_ungroupGroupBy_ungroup
GroupBy VarGroupBy_var
Return the first or the last 'n' parts of an objecthead.RPolarsDataFrame head.RPolarsLazyFrame tail.RPolarsDataFrame tail.RPolarsLazyFrame
Infer nanoarrow schema from a Polars objectinfer_nanoarrow_schema.RPolarsDataFrame infer_nanoarrow_schema.RPolarsSeries
Test if the object is a polars DataFrameis_polars_df
Test if the object a polars DataTypeis_polars_dtype
Test if the object is a polars LazyFrameis_polars_lf
Test if the object is a polars Seriesis_polars_series
knit print polars DataFrameknit_print.RPolarsDataFrame
Cast LazyFrame column(s) to the specified dtypeLazyFrame_cast
Inner workings of the LazyFrame-classLazyFrame_class RPolarsLazyFrame
Create an empty or n-row null-filled copy of the LazyFrameLazyFrame_clear
Clone a LazyFrameLazyFrame_clone
Collect a query into a DataFrameLazyFrame_collect
Collect a query in backgroundLazyFrame_collect_in_background
Drop columns of a LazyFrameLazyFrame_drop
Drop nulls (missing values)LazyFrame_drop_nulls
Create a string representation of the query planLazyFrame_explain
Explode columns containing a list of valuesLazyFrame_explode
Fetch 'n' rows of a LazyFrameLazyFrame_fetch
Fill floating point NaN value with a fill valueLazyFrame_fill_nan
Fill nullsLazyFrame_fill_null
Apply filter to LazyFrameLazyFrame_filter
Get the first row of a LazyFrameLazyFrame_first
Take every nth row in the LazyFrameLazyFrame_gather_every
Group a LazyFrameLazyFrame_group_by
Group based on a date/time or integer columnLazyFrame_group_by_dynamic
Get the first 'n' rows.LazyFrame_head
Join LazyFramesLazyFrame_join
Perform joins on nearest keysLazyFrame_join_asof
Perform a join based on one or multiple (in)equality predicatesLazyFrame_join_where
Get the last row of a LazyFrameLazyFrame_last
MaxLazyFrame_max
MeanLazyFrame_mean
MedianLazyFrame_median
MinLazyFrame_min
print LazyFrame internal methodLazyFrame_print
Collect and profile a lazy query.LazyFrame_profile
QuantileLazyFrame_quantile
Rename column names of a LazyFrameLazyFrame_rename
ReverseLazyFrame_reverse
Create rolling groups based on a date/time or integer columnLazyFrame_rolling
Select and modify columns of a LazyFrameLazyFrame_select
Select and modify columns of a LazyFrameLazyFrame_select_seq
Serialize the logical plan of this LazyFrame to a file or string in JSON formatLazyFrame_serialize
Shift a LazyFrameLazyFrame_shift
Stream the output of a query to a CSV fileLazyFrame_sink_csv
Stream the output of a query to an Arrow IPC fileLazyFrame_sink_ipc
Stream the output of a query to a JSON fileLazyFrame_sink_ndjson
Stream the output of a query to a Parquet fileLazyFrame_sink_parquet
SliceLazyFrame_slice
Sort the LazyFrame by the given columnsLazyFrame_sort
Execute a SQL query against the LazyFrameLazyFrame_sql
StdLazyFrame_std
SumLazyFrame_sum
Get the last 'n' rows.LazyFrame_tail
Plot the query planLazyFrame_to_dot
Drop duplicated rowsLazyFrame_unique
Unnest the Struct columns of a LazyFrameLazyFrame_unnest
Unpivot a Frame from wide to long formatLazyFrame_unpivot
VarLazyFrame_var
Select and modify columns of a LazyFrameLazyFrame_with_columns
Select and modify columns of a LazyFrameLazyFrame_with_columns_seq
Add an external context to the computation graphLazyFrame_with_context
Add a column for row indicesLazyFrame_with_row_index
LazyGroupBy_aggLazyGroupBy_agg
Operations on Polars grouped LazyFrameLazyGroupBy_class RPolarsLazyGroupBy
LazyGroupBy_headLazyGroupBy_head
LazyGroupBy_printLazyGroupBy_print
LazyGroupBy_tailLazyGroupBy_tail
LazyGroupBy_ungroupLazyGroupBy_ungroup
Get the lengthlength.RPolarsDataFrame length.RPolarsLazyFrame length.RPolarsSeries
Compute the maximum valuemax.RPolarsDataFrame max.RPolarsLazyFrame max.RPolarsSeries
Compute the meanmean.RPolarsDataFrame mean.RPolarsLazyFrame mean.RPolarsSeries
Compute the medianmedian.RPolarsDataFrame median.RPolarsLazyFrame median.RPolarsSeries
Compute the minimum valuemin.RPolarsDataFrame min.RPolarsLazyFrame min.RPolarsSeries
Drop missing valuesna.omit.RPolarsDataFrame na.omit.RPolarsLazyFrame
Get the column namesnames.RPolarsDataFrame names.RPolarsGroupBy names.RPolarsLazyFrame names.RPolarsLazyGroupBy
New Expr referring to all columnspl_all
Apply the AND logical rowwisepl_all_horizontal
Apply the OR logical rowwisepl_any_horizontal
Approximate count of unique valuespl_approx_n_unique
Return the row indices that would sort the columnspl_arg_sort_by
Return indices that match a conditionpl_arg_where
Coalescepl_coalesce
Create an expression representing column(s) in a dataframepl_col
Concat polars objectspl_concat
Concat the arrays in a Series dtype List in linear time.pl_concat_list
Horizontally concatenate columns into a single string columnpl_concat_str
Correlationpl_corr
Return the number of non-null values in the column.pl_count
Covariancepl_cov
Create a new polars DataFramepl_DataFrame
Create a Date expressionpl_date
Generate a date rangepl_date_range
Generate a list containing a date rangepl_date_ranges
Create a Datetime expressionpl_datetime
Generate a datetime rangepl_datetime_range
Generate a list containing a datetime rangepl_datetime_ranges
Read a logical plan from a JSON file to construct a LazyFramepl_deserialize_lf
Disable the global string cachepl_disable_string_cache
DataTypes (RPolarsDataType)pl_dtypes RPolarsDataType
Create polars Duration from distinct time componentspl_duration
an element in 'eval'-exprelement pl_element
Enable the global string cachepl_enable_string_cache
Quickly select a field in a Structpl_field
Create Fieldpl_Field pl_Field_class
Get the first value.pl_first
Accumulate over multiple columns horizontally with an R functionpl_fold
Convert a Unix timestamp to date(time)pl_from_epoch
Get the first 'n' rows.pl_head
Aggregate all column values into a list.pl_implode
Generate a range of integerspl_int_range
Generate a range of integers for each row of the input columnspl_int_ranges
check if schemapl_is_schema
Get the last value.pl_last
Create new LazyFramepl_LazyFrame
Return the number of rows in the context.pl_len
Create a literal valuepl_lit
Get the maximum value.pl_max
Get the maximum value rowwisepl_max_horizontal
Get the mean value.pl_mean
Compute the mean rowwisepl_mean_horizontal
Get the median value.pl_median
Get Memory Addresspl_mem_address
Get the minimum value.pl_min
Get the minimum value rowwisepl_min_horizontal
Count unique values.pl_n_unique
The complete polars public API.pl pl_pl
Store Time in Rpl_PTime PTIME
Polars raw listas.list.rpolars_raw_list pl_raw_list [.rpolars_raw_list
New DataFrame from CSVpl_read_csv
Read into a DataFrame from Arrow IPC (Feather v2) filepl_read_ipc
New DataFrame from NDJSONpl_read_ndjson
Read a parquet filepl_read_parquet
Accumulate over multiple columns horizontally with an R functionpl_reduce
Rolling correlationpl_rolling_corr
Rolling covariancepl_rolling_cov
New LazyFrame from CSVpl_scan_csv
Lazily read from an Arrow IPC (Feather v2) file or multiple files via glob patternspl_scan_ipc
New LazyFrame from NDJSONpl_scan_ndjson
Scan a parquet filepl_scan_parquet
Select from an empty DataFramepl_select
Create new Seriespl_Series Series
Initialise a new SQLContextpl_SQLContext
Get the standard deviation.pl_std
Collect columns into a struct columnpl_struct
Sum all values.pl_sum
Compute the sum rowwisepl_sum_horizontal
Get the last 'n' rows.pl_tail
Get the number of threads in the Polars thread pool.pl_thread_pool_size
Create a Time expressionpl_time
Check if the global string cache is enabledpl_using_string_cache
Get the variance.pl_var
Evaluate one or several expressions with global string cachepl_with_string_cache
Any polars class object is made of thispolars_class_object
Polars code completionpolars_code_completion_activate polars_code_completion_deactivate
The Polars duration string languagepolars_duration_string
Get polars environment variablespolars_envvars
Report information of the packagepolars_info
Get and reset polars optionspolars_options polars_options_reset
Print valuesprint.RPolarsSeries
Aggregate over a RollingGroupByRollingGroupBy_agg
Operations on Polars DataFrame grouped by rolling windowsRollingGroupBy_class RPolarsRollingGroupBy
Ungroup a RollingGroupBy objectRollingGroupBy_ungroup
Get the row namesrow.names.RPolarsDataFrame
The RPolarsRThreadHandle classRPolarsRThreadHandle RThreadHandle_class
Ask if RThreadHandle is finished?RThreadHandle_is_finished
Join a RThreadHandleRThreadHandle_join
Arithmetic operators for RPolars objects%%.RPolarsExpr %%.RPolarsSeries %/%.RPolarsExpr %/%.RPolarsSeries *.RPolarsExpr *.RPolarsSeries +.RPolarsExpr +.RPolarsSeries -.RPolarsExpr -.RPolarsSeries /.RPolarsExpr /.RPolarsSeries S3_arithmetic ^.RPolarsExpr ^.RPolarsSeries
Add SeriesSeries_add
Change name of SeriesSeries_alias
Reduce Boolean Series with ALLSeries_all
Reduce boolean Series with ANYSeries_any
Append two SeriesSeries_append
Index of max valueSeries_arg_max
Index of min valueSeries_arg_min
Lengths of Series memory chunksSeries_chunk_lengths
Inner workings of the Series-classRPolarsSeries Series_class
Create an empty or n-row null-filled copy of the SeriesSeries_clear
Clone a SeriesSeries_clone
Compare Series!=.RPolarsSeries <.RPolarsSeries <=.RPolarsSeries ==.RPolarsSeries >.RPolarsSeries >=.RPolarsSeries Series_compare
Divide SeriesSeries_div
Are two Series equal?Series_equals
Floor Divide SeriesSeries_floor_div
Check if the Series is numericSeries_is_numeric
Check if the Series is sortedSeries_is_sorted
Return the element at the given indexSeries_item
Length of a SeriesSeries_len
Apply every value with an R funapply Series_map_elements
Find the max of a SeriesSeries_max
Compute the mean of a SeriesSeries_mean
Compute the median of a SeriesSeries_median
Find the min of a SeriesSeries_min
Modulo SeriesSeries_mod
Multiply SeriesSeries_mul
Get the number of chunks that this Series contains.Series_n_chunks
Count unique values in SeriesSeries_n_unique
Power SeriesSeries_pow
Print SeriesSeries_print
Rename a seriesSeries_rename
Duplicate and concatenate a seriesSeries_rep
Set a sorted flag on a SeriesSeries_set_sorted
Sort a SeriesSeries_sort
Compute the standard deviation of a SeriesSeries_std
Subtract SeriesSeries_sub
Compute the sum of a SeriesSeries_sum
Convert Series to DataFrameSeries_to_frame
Convert a Series to literalSeries_to_lit
Convert Series to R vector or listSeries_to_list Series_to_r Series_to_vector
Count the occurrences of unique valuesSeries_value_counts
Compute the variance of a SeriesSeries_var
show all public functions / objectspl_show_all_public_functions show_all_public_functions
show all public methodspl_show_all_public_methods show_all_public_methods
Run SQL queries against DataFrame/LazyFrame data.RPolarsSQLContext SQLContext_class
Execute SQL query against the registered dataSQLContext_execute
Register a single data as a tableSQLContext_register
Register all polars DataFrames/LazyFrames found in the environmentSQLContext_register_globals
Register multiple data as tablesSQLContext_register_many
List registered tablesSQLContext_tables
Unregister tables by nameSQLContext_unregister
Compute the sumsum.RPolarsDataFrame sum.RPolarsLazyFrame sum.RPolarsSeries
Drop duplicated rowsunique.RPolarsDataFrame unique.RPolarsLazyFrame