Package index

Import data

Functions to import data as Polars DataFrames (read_ functions) and LazyFrames (scan_ functions).

read_csv_polars() scan_csv_polars(): Import data from CSV file(s)

read_ipc_polars() scan_ipc_polars(): Import data from IPC file(s)

read_ndjson_polars() scan_ndjson_polars(): Import data from NDJSON file(s)

read_parquet_polars() scan_parquet_polars(): Import data from Parquet file(s)

Export data

Functions to export Polars DataFrames (write_ functions) and LazyFrames (sink_ functions).

sink_csv(): Stream output to a CSV file

sink_ipc(): Stream output to an IPC file

sink_ndjson(): Stream output to a NDJSON file

sink_parquet(): Stream output to a parquet file

write_csv_polars(): Export data to CSV file(s)

write_ipc_polars(): Export data to IPC file(s)

write_json_polars(): Export data to JSON file(s)

write_ndjson_polars(): Export data to NDJSON file(s)

write_parquet_polars(): Export data to Parquet file(s)

Functions from `dplyr`

count(<RPolarsDataFrame>) count(<RPolarsLazyFrame>) add_count(<RPolarsDataFrame>) add_count(<RPolarsLazyFrame>): Count the observations in each group

semi_join(<RPolarsDataFrame>) anti_join(<RPolarsDataFrame>) semi_join(<RPolarsLazyFrame>) anti_join(<RPolarsLazyFrame>): Filtering joins

arrange(<RPolarsDataFrame>): Order rows using column values

bind_cols_polars(): Append multiple Data/LazyFrames next to each other

bind_rows_polars(): Stack multiple Data/LazyFrames on top of each other

compute(<RPolarsLazyFrame>) collect(<RPolarsLazyFrame>): Collect a LazyFrame

cross_join(<RPolarsDataFrame>) cross_join(<RPolarsLazyFrame>): Cross join

distinct(<RPolarsDataFrame>) distinct(<RPolarsLazyFrame>) duplicated_rows(): Remove or keep only duplicated rows in a Data/LazyFrame

explain(<RPolarsLazyFrame>): Show the optimized and non-optimized query plans

filter(<RPolarsDataFrame>) filter(<RPolarsLazyFrame>): Keep rows that match a condition

left_join(<RPolarsDataFrame>) right_join(<RPolarsDataFrame>) full_join(<RPolarsDataFrame>) inner_join(<RPolarsDataFrame>) left_join(<RPolarsLazyFrame>) right_join(<RPolarsLazyFrame>) full_join(<RPolarsLazyFrame>) inner_join(<RPolarsLazyFrame>): Mutating joins

group_by(<RPolarsDataFrame>) ungroup(<RPolarsDataFrame>) group_by(<RPolarsLazyFrame>) ungroup(<RPolarsLazyFrame>): Group by one or more variables

group_split(<RPolarsDataFrame>): Grouping metadata

group_vars(<RPolarsDataFrame>) group_vars(<RPolarsLazyFrame>) group_keys(<RPolarsDataFrame>) group_keys(<RPolarsLazyFrame>): Grouping metadata

mutate(<RPolarsDataFrame>) mutate(<RPolarsLazyFrame>): Create, modify, and delete columns

pull(<RPolarsDataFrame>) pull(<RPolarsLazyFrame>): Extract a variable of a Data/LazyFrame

relocate(<RPolarsDataFrame>) relocate(<RPolarsLazyFrame>): Change column order

rename(<RPolarsDataFrame>) rename(<RPolarsLazyFrame>) rename_with(<RPolarsDataFrame>) rename_with(<RPolarsLazyFrame>): Rename columns

rowwise(<RPolarsDataFrame>) rowwise(<RPolarsLazyFrame>): Group input by rows

select(<RPolarsDataFrame>) select(<RPolarsLazyFrame>): Select columns from a Data/LazyFrame

separate(<RPolarsDataFrame>) separate(<RPolarsLazyFrame>): Separate a character column into multiple columns based on a substring

slice_tail(<RPolarsDataFrame>) slice_tail(<RPolarsLazyFrame>) slice_head(<RPolarsDataFrame>) slice_head(<RPolarsLazyFrame>) slice_sample(<RPolarsDataFrame>): Subset rows of a Data/LazyFrame

summarize(<RPolarsDataFrame>) summarise(<RPolarsDataFrame>) summarize(<RPolarsLazyFrame>) summarise(<RPolarsLazyFrame>): Summarize each group down to one row

Functions from `tidyr`

complete(<RPolarsDataFrame>) complete(<RPolarsLazyFrame>): Complete a data frame with missing combinations of data

drop_na(<RPolarsDataFrame>) drop_na(<RPolarsLazyFrame>): Drop missing values

fill(<RPolarsDataFrame>): Fill in missing values with previous or next value

pivot_longer(<RPolarsDataFrame>) pivot_longer(<RPolarsLazyFrame>): Pivot a Data/LazyFrame from wide to long

pivot_wider(<RPolarsDataFrame>): Pivot a DataFrame from long to wide

replace_na(<RPolarsDataFrame>) replace_na(<RPolarsLazyFrame>): Replace NAs with specified values

separate(<RPolarsDataFrame>) separate(<RPolarsLazyFrame>): Separate a character column into multiple columns based on a substring

uncount(<RPolarsDataFrame>) uncount(<RPolarsLazyFrame>): Uncount a Data/LazyFrame

unite(<RPolarsDataFrame>) unite(<RPolarsLazyFrame>): Unite multiple columns into one by pasting strings together

Other methods

Other functions or S3 methods.

as_tibble(<tidypolars>): Convert a Polars DataFrame to an R data.frame or to a tibble

summary(<RPolarsDataFrame>): Summary statistics for a Polars DataFrame

tidypolars-options: tidypolars global options

Other Polars functions

Other Polars-specific functions (most are deprecated).

describe() deprecated: Summary statistics for a Polars DataFrame

describe_plan() describe_optimized_plan() deprecated: Show the optimized and non-optimized query plans

fetch(): Fetch n rows of a LazyFrame

make_unique_id(): Create a column with unique id per row values