| Create a Polars DataFrame from an R object | as_polars_df as_polars_df.data.frame as_polars_df.default as_polars_df.list as_polars_df.NULL as_polars_df.polars_data_frame as_polars_df.polars_group_by as_polars_df.polars_lazy_frame as_polars_df.polars_series |
| Create a Polars expression from an R object | as_polars_expr as_polars_expr.character as_polars_expr.default as_polars_expr.double as_polars_expr.integer as_polars_expr.logical as_polars_expr.NULL as_polars_expr.polars_expr as_polars_expr.polars_series as_polars_expr.raw |
| Create a Polars LazyFrame from an R object | as_polars_lf as_polars_lf.default as_polars_lf.polars_lazy_frame |
| Create a Polars Series from an R object | as_polars_series as_polars_series.array as_polars_series.AsIs as_polars_series.blob as_polars_series.character as_polars_series.clock_duration 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.Date as_polars_series.default as_polars_series.difftime as_polars_series.double as_polars_series.factor as_polars_series.hms as_polars_series.integer as_polars_series.integer64 as_polars_series.ITime as_polars_series.list as_polars_series.logical as_polars_series.NULL as_polars_series.polars_data_frame as_polars_series.polars_series as_polars_series.POSIXct as_polars_series.POSIXlt as_polars_series.raw as_polars_series.vctrs_rcrd as_polars_series.vctrs_unspecified |
| Export the polars object as a tibble data frame | as_tibble.polars_data_frame as_tibble.polars_lazy_frame |
| Export the polars object as an R DataFrame | as.data.frame.polars_data_frame as.data.frame.polars_lazy_frame |
| Export the polars object as an R list | as.list.polars_data_frame as.list.polars_lazy_frame |
| Check if the object is a polars object | check_list_of_polars_dtype check_polars check_polars_df check_polars_dtype check_polars_expr check_polars_lf check_polars_selector check_polars_series is_list_of_polars_dtype is_polars is_polars_df is_polars_dtype is_polars_expr is_polars_lf is_polars_selector is_polars_series |
| Polars column selector function namespace | cs |
| Select all columns | cs__all |
| Select all columns with alphabetic names (e.g. only letters) | cs__alpha |
| Select all columns with alphanumeric names (e.g. only letters and the digits 0-9) | cs__alphanumeric |
| Select all binary columns | cs__binary |
| Select all boolean columns | cs__boolean |
| Select all columns matching the given dtypes | cs__by_dtype |
| Select all columns matching the given indices (or range objects) | cs__by_index |
| Select all columns matching the given names | cs__by_name |
| Select all categorical columns | cs__categorical |
| Select columns whose names contain the given literal substring(s) | cs__contains |
| Select all date columns | cs__date |
| Select all datetime columns | cs__datetime |
| Select all decimal columns | cs__decimal |
| Select all columns having names consisting only of digits | cs__digit |
| Select all duration columns, optionally filtering by time unit | cs__duration |
| Select columns that end with the given substring(s) | cs__ends_with |
| Select all columns except those matching the given columns, datatypes, or selectors | cs__exclude |
| Select the first column in the current scope | cs__first |
| Select all float columns. | cs__float |
| Select all integer columns. | cs__integer |
| Select the last column in the current scope | cs__last |
| Select all columns that match the given regex pattern | cs__matches |
| Select all numeric columns. | cs__numeric |
| Select all signed integer columns | cs__signed_integer |
| Select columns that start with the given substring(s) | cs__starts_with |
| Select all String (and, optionally, Categorical) string columns. | cs__string |
| Select all temporal columns | cs__temporal |
| Select all time columns | cs__time |
| Select all unsigned integer columns | cs__unsigned_integer |
| Cast DataFrame column(s) to the specified dtype | dataframe__cast |
| Clone a DataFrame | dataframe__clone |
| Drop columns of a DataFrame | dataframe__drop |
| Check whether the DataFrame is equal to another DataFrame | dataframe__equals |
| Filter rows of a DataFrame | dataframe__filter |
| Get the DataFrame as a list of Series | dataframe__get_columns |
| Group a DataFrame | dataframe__group_by |
| Convert an existing DataFrame to a LazyFrame | dataframe__lazy |
| Get number of chunks used by the ChunkedArrays of this DataFrame | dataframe__n_chunks |
| Rechunk the data in this DataFrame to a contiguous allocation | dataframe__rechunk |
| Select and modify columns of a DataFrame | dataframe__select |
| Get a slice of the DataFrame. | dataframe__slice |
| Sort a DataFrame | dataframe__sort |
| Select column as Series at index location | dataframe__to_series |
| Convert a DataFrame to a Series of type Struct | dataframe__to_struct |
| Modify/append column(s) of a DataFrame | dataframe__with_columns |
| Evaluate whether all boolean values are true for every sub-array | expr_arr_all |
| Evaluate whether any boolean value is true for every sub-array | expr_arr_any |
| Retrieve the index of the maximum value in every sub-array | expr_arr_arg_max |
| Retrieve the index of the minimum value in every sub-array | expr_arr_arg_min |
| Check if sub-arrays contain the given item | expr_arr_contains |
| Count how often a value occurs in every sub-array | expr_arr_count_matches |
| Explode array in separate rows | expr_arr_explode |
| Get the first value of the sub-arrays | expr_arr_first |
| Get the value by index in every sub-array | expr_arr_get |
| Join elements in every sub-array | expr_arr_join |
| Get the last value of the sub-arrays | expr_arr_last |
| Compute the max value of the sub-arrays | expr_arr_max |
| Compute the median value of the sub-arrays | expr_arr_median |
| Compute the min value of the sub-arrays | expr_arr_min |
| Count the number of unique values in every sub-array | expr_arr_n_unique |
| Reverse values in every sub-array | expr_arr_reverse |
| Shift values in every sub-array by the given number of indices | expr_arr_shift |
| Sort values in every sub-array | expr_arr_sort |
| Compute the standard deviation of the sub-arrays | expr_arr_std |
| Compute the sum of the sub-arrays | expr_arr_sum |
| Convert an Array column into a List column with the same inner data type | expr_arr_to_list |
| Get the unique values in every sub-array | expr_arr_unique |
| Compute the variance of the sub-arrays | expr_arr_var |
| Check if binaries contain a binary substring | expr_bin_contains |
| Decode values using the provided encoding | expr_bin_decode |
| Encode a value using the provided encoding | expr_bin_encode |
| Check if string values end with a binary substring | expr_bin_ends_with |
| Get the size of binary values in the given unit | expr_bin_size |
| Check if values start with a binary substring | expr_bin_starts_with |
| Get the categories stored in this data type | expr_cat_get_categories |
| Set Ordering | expr_cat_set_ordering |
| Offset by 'n' business days. | expr_dt_add_business_days |
| Base offset from UTC | expr_dt_base_utc_offset |
| Change time unit | expr_dt_cast_time_unit |
| Extract the century from underlying representation | expr_dt_century |
| Combine Date and Time | expr_dt_combine |
| Convert to given time zone for an expression of type Datetime | expr_dt_convert_time_zone |
| Extract date from date(time) | expr_dt_date |
| Extract day from underlying Date representation | expr_dt_day |
| Daylight savings offset from UTC | expr_dt_dst_offset |
| Get epoch of given Datetime | expr_dt_epoch |
| Extract hour from underlying Datetime representation | expr_dt_hour |
| Determine whether the year of the underlying date is a leap year | expr_dt_is_leap_year |
| Extract ISO year from underlying Date representation | expr_dt_iso_year |
| Extract microseconds from underlying Datetime representation | expr_dt_microsecond |
| Extract milliseconds from underlying Datetime representation | expr_dt_millisecond |
| Extract minute from underlying Datetime representation | expr_dt_minute |
| Extract month from underlying Date representation | expr_dt_month |
| Roll forward to the last day of the month | expr_dt_month_end |
| Roll backward to the first day of the month | expr_dt_month_start |
| Extract nanoseconds from underlying Datetime representation | expr_dt_nanosecond |
| Offset a date by a relative time offset | expr_dt_offset_by |
| Extract ordinal day from underlying Date representation | expr_dt_ordinal_day |
| Extract quarter from underlying Date representation | expr_dt_quarter |
| Replace time zone for an expression of type Datetime | expr_dt_replace_time_zone |
| Round datetime | expr_dt_round |
| Extract seconds from underlying Datetime representation | expr_dt_second |
| Convert a Date/Time/Datetime/Duration column into a String column with the given format | expr_dt_strftime |
| Extract time | expr_dt_time |
| Get timestamp in the given time unit | expr_dt_timestamp |
| Convert a Date/Time/Datetime/Duration column into a String column with the given format | expr_dt_to_string |
| Extract the days from a Duration type | expr_dt_total_days |
| Extract the hours from a Duration type | expr_dt_total_hours |
| Extract the microseconds from a Duration type | expr_dt_total_microseconds |
| Extract the milliseconds from a Duration type | expr_dt_total_milliseconds |
| Extract the minutes from a Duration type | expr_dt_total_minutes |
| Extract the nanoseconds from a Duration type | expr_dt_total_nanoseconds |
| Extract the seconds from a Duration type | expr_dt_total_seconds |
| Truncate datetime | expr_dt_truncate |
| Extract week from underlying Date representation | expr_dt_week |
| Extract weekday from underlying Date representation | expr_dt_weekday |
| Set time unit of a Series of dtype Datetime or Duration | expr_dt_with_time_unit |
| Extract year from underlying Date representation | expr_dt_year |
| Evaluate whether all boolean values in a sub-list are true | expr_list_all |
| Evaluate whether any boolean value in a sub-list is true | expr_list_any |
| Retrieve the index of the maximum value in every sub-list | expr_list_arg_max |
| Retrieve the index of the minimum value in every sub-list | expr_list_arg_min |
| Concat the lists into a new list | expr_list_concat |
| Check if sub-lists contains a given value | expr_list_contains |
| Count how often a value produced occurs | expr_list_count_matches |
| Compute difference between sub-list values | expr_list_diff |
| Drop all null values in every sub-list | expr_list_drop_nulls |
| Run any polars expression on the sub-lists' values | expr_list_eval |
| Returns a column with a separate row for every list element | expr_list_explode |
| Get the first value of the sub-lists | expr_list_first |
| Get several values by index in every sub-list | expr_list_gather |
| Take every 'n'-th value starting from offset in sub-lists | expr_list_gather_every |
| Get the value by index in every sub-list | expr_list_get |
| Slice the first 'n' values of every sub-list | expr_list_head |
| Join elements of every sub-list | expr_list_join |
| Get the last value of the sub-lists | expr_list_last |
| Return the number of elements in each sub-list | expr_list_len |
| Compute the maximum value in every sub-list | expr_list_max |
| Compute the mean value in every sub-list | expr_list_mean |
| Compute the median in every sub-list | expr_list_median |
| Compute the miminum value in every sub-list | expr_list_min |
| Count the number of unique values in every sub-lists | expr_list_n_unique |
| Reverse values in every sub-list | expr_list_reverse |
| Sample values from every sub-list | expr_list_sample |
| Compute the set difference between elements of a list and other elements | expr_list_set_difference |
| Compute the intersection between elements of a list and other elements | expr_list_set_intersection |
| Compute the set symmetric difference between elements of a list and other elements | expr_list_set_symmetric_difference |
| Compute the union of elements of a list and other elements | expr_list_set_union |
| Shift list values by the given number of indices | expr_list_shift |
| Slice every sub-list | expr_list_slice |
| Sort values in every sub-list | expr_list_sort |
| Compute the standard deviation in every sub-list | expr_list_std |
| Sum all elements in every sub-list | expr_list_sum |
| Slice the last 'n' values of every sub-list | expr_list_tail |
| Convert a List column into an Array column with the same inner data type | expr_list_to_array |
| Get unique values in a list | expr_list_unique |
| Compute the variance in every sub-list | expr_list_var |
| Indicate if this expression is the same as another expression | expr_meta_eq |
| Indicate if this expression expands into multiple expressions | expr_meta_has_multiple_outputs |
| Indicate if this expression is a basic (non-regex) unaliased column | expr_meta_is_column |
| Indicate if this expression only selects columns (optionally with aliasing) | expr_meta_is_column_selection |
| Indicate if this expression expands to columns that match a regex pattern | expr_meta_is_regex_projection |
| Indicate if this expression is not the same as another expression | expr_meta_ne |
| Get the column name that this expression would produce | expr_meta_output_name |
| Pop the latest expression and return the input(s) of the popped expression | expr_meta_pop |
| Get a list with the root column name | expr_meta_root_names |
| Serialize this expression to a string in binary or JSON format | expr_meta_serialize |
| Format the expression as a tree | expr_meta_tree_format |
| Undo any renaming operation like 'alias' or 'name$keep' | expr_meta_undo_aliases |
| Check if string contains a substring that matches a pattern | expr_str_contains |
| Use the aho-corasick algorithm to find matches | expr_str_contains_any |
| Count all successive non-overlapping regex matches | expr_str_count_matches |
| Decode a value using the provided encoding | expr_str_decode |
| Encode a value using the provided encoding | expr_str_encode |
| Check if string ends with a regex | expr_str_ends_with |
| Extract the target capture group from provided patterns | expr_str_extract |
| Extract all matches for the given regex pattern | expr_str_extract_all |
| Extract all capture groups for the given regex pattern | expr_str_extract_groups |
| Use the aho-corasick algorithm to extract matches | expr_str_extract_many |
| Return the index position of the first substring matching a pattern | expr_str_find |
| Return the first n characters of each string | expr_str_head |
| Vertically concatenate the string values in the column to a single string value. | expr_str_join |
| Parse string values as JSON. | expr_str_json_decode |
| Extract the first match of JSON string with the provided JSONPath expression | expr_str_json_path_match |
| Get the number of bytes in strings | expr_str_len_bytes |
| Get the number of characters in strings | expr_str_len_chars |
| Left justify strings | expr_str_pad_end |
| Right justify strings | expr_str_pad_start |
| Replace first matching regex/literal substring with a new string value | expr_str_replace |
| Replace all matching regex/literal substrings with a new string value | expr_str_replace_all |
| Use the aho-corasick algorithm to replace many matches | expr_str_replace_many |
| Returns string values in reversed order | expr_str_reverse |
| Create subslices of the string values of a String Series | expr_str_slice |
| Split the string by a substring | expr_str_split |
| Split the string by a substring using 'n' splits | expr_str_split_exact |
| Split the string by a substring, restricted to returning at most 'n' items | expr_str_splitn |
| Check if string starts with a regex | expr_str_starts_with |
| Strip leading and trailing characters | expr_str_strip_chars |
| Strip trailing characters | expr_str_strip_chars_end |
| Strip leading characters | expr_str_strip_chars_start |
| Convert a String column into a Date/Datetime/Time column. | expr_str_strptime |
| Return the last n characters of each string | expr_str_tail |
| Convert a String column into a Date column | expr_str_to_date |
| Convert a String column into a Datetime column | expr_str_to_datetime |
| Convert a String column into an Int64 column with base radix | expr_str_to_integer |
| Convert a string to lowercase | expr_str_to_lowercase |
| Convert a String column into a Time column | expr_str_to_time |
| Convert a string to uppercase | expr_str_to_uppercase |
| Fills the string with zeroes. | expr_str_zfill |
| Retrieve one or multiple Struct field(s) as a new Series | expr_struct_field |
| Convert this struct to a string column with json values | expr_struct_json_encode |
| Rename the fields of the struct | expr_struct_rename_fields |
| Expand the struct into its individual fields | expr_struct_unnest |
| Add or overwrite fields of this struct | expr_struct_with_fields |
| Materialize this LazyFrame into a DataFrame | lazyframe__collect |
| Select and modify columns of a LazyFrame | lazyframe__select |
| Modify/append column(s) of a LazyFrame | lazyframe__with_columns |
| Polars top-level function namespace | pl |
| Apply the AND logical horizontally across columns | pl__all_horizontal |
| Apply the OR logical horizontally across columns | pl__any_horizontal |
| Folds the columns from left to right, keeping the first non-null value | pl__coalesce |
| Create an expression representing column(s) in a DataFrame | pl__col |
| Combine multiple DataFrames, LazyFrames, or Series into a single object | pl__concat |
| Horizontally concatenate columns into a single list column | pl__concat_list |
| Polars DataFrame class ('polars_data_frame') | DataFrame pl__DataFrame polars_data_frame |
| Generate a date range | pl__date_range |
| Create a column of date ranges | pl__date_ranges |
| Create a Polars literal expression of type Datetime | pl__datetime |
| Generate a datetime range | pl__datetime_range |
| Generate a list containing a datetime range | pl__datetime_ranges |
| Create polars Duration from distinct time components | pl__duration |
| Alias for an element being evaluated in an eval expression | pl__element |
| Get the first column of the context | pl__first |
| Generate a range of integers | pl__int_range |
| Generate a range of integers for each row of the input columns | pl__int_ranges |
| Get the last column of the context | pl__last |
| Polars LazyFrame class ('polars_lazy_frame') | LazyFrame pl__LazyFrame polars_lazy_frame |
| Return an expression representing a literal value | pl__lit |
| Get the maximum value horizontally across columns | pl__max_horizontal |
| Compute the mean horizontally across columns | pl__mean_horizontal |
| Get the minimum value horizontally across columns | pl__min_horizontal |
| Get the nth column(s) of the context | pl__nth |
| Read into a DataFrame from Arrow IPC (Feather v2) file | pl__read_ipc |
| Read into a DataFrame from Parquet file | pl__read_parquet |
| Lazily read from an Arrow IPC (Feather v2) file or multiple files via glob patterns | pl__scan_ipc |
| Lazily read from a local or cloud-hosted parquet file (or files) | pl__scan_parquet |
| Polars Series class ('polars_series') | pl__Series polars_series Series |
| Print out the version of Polars and its optional dependencies | pl__show_versions |
| Collect columns into a struct column | pl__struct |
| Compute the sum horizontally across columns | pl__sum_horizontal |
| Generate a time range | pl__time_range |
| Create a column of time ranges | pl__time_ranges |
| Registering custom functionality with a polars Series | pl_api_register_series_namespace |
| Polars DataType class ('polars_dtype') | DataType pl__Array pl__Categorical pl__Datetime pl__Decimal pl__Duration pl__Enum pl__List pl__Struct polars_dtype |
| The Polars duration string language | polars_duration_string |
| Polars expression class ('polars_expr') | Expr expression polars_expr |
| Get the number of chunks that this Series contains | series__n_chunks |
| Cast this Series to a DataFrame | series__to_frame |
| Export the Series as an R vector | series__to_r_vector |
| Convert this struct Series to a DataFrame with a separate column for each field | series_struct_unnest |
