Pkg/polars/DataFrame

DataFrame

struct DataFrame

A contiguous growable collection of Series that have the same length.

Implementions

ToString

Operators

pub fn operator !=(self, b: DataFrame): bool

pub fn operator ==(self, b: DataFrame): bool

Static Methods

pub fn empty(): DataFrame

Creates an empty DataFrame.

pub fn new(columns: [Column], broadcast: bool = false): DataFrame throws PolarsError

Create a DataFrame from columns.

Methods

pub fn add_column(self, column: Column) throws PolarsError

Add a new column to this DataFrame or replace an existing one.

pub fn clone(self): DataFrame

Clone the data frame.

pub fn columns(self): [Column] throws PolarsError

Returns columns of the DataFrame.

pub fn drop(self, name: string): DataFrame throws PolarsError

Drop a column by name.

This is a pure method and will return a new DataFrame instead of modifying the current one in place.

pub fn drop_in_place(self, name: string): Column throws PolarsError

Remove a column by name and return the column removed.

pub fn drop_nulls(self, subset: [string]? = nil): DataFrame throws PolarsError

Return a new DataFrame where all null values are dropped.

pub fn dtypes(self): [DataType]

pub fn eq_missing(self, b: DataFrame): bool

pub fn explode(self, columns: [string]): DataFrame throws PolarsError

Explode DataFrame to long format by exploding a column with Lists.

pub fn extend(self, other: DataFrame) throws PolarsError

Extend the memory backed by this DataFrame with the values from other.

pub fn fields(self): [Field]

Get a reference to the schema fields of the DataFrame.

pub fn fill_null(self, strategy: FillNullStrategy): DataFrame throws PolarsError

[src]

pub fn fill_null(self, strategy: FillNullStrategy): DataFrame throws PolarsError {
    return try self._fill_null(strategy as int);
}

Replace null values with one of the following strategies.

Forward fill (replace None with the previous value)
Backward fill (replace None with the next value)
Mean fill (replace None with the mean of the whole array)
Min fill (replace None with the minimum of the whole array)
Max fill (replace None with the maximum of the whole array)

pub fn filter(self, mask: BooleanChunked): DataFrame throws PolarsError

Take the DataFrame rows by a boolean mask.

pub fn head(self, n: int): DataFrame

Get the head of the DataFrame.

pub fn height(self): int

Get the height of the DataFrame which is the number of rows.

pub fn hstack(self, columns: [Column]): DataFrame throws PolarsError

Add multiple Series to a DataFrame.

The added Series are required to have the same length.

pub fn insert_column(self, index: int, column: Column) throws PolarsError

Insert a new column at a given index.

pub fn is_duplicated(self): BooleanChunked throws PolarsError

Get a mask of all the duplicated rows in the DataFrame.

pub fn is_empty(self): bool

Returns true if the DataFrame contains no rows.

pub fn is_unique(self): BooleanChunked throws PolarsError

Get a mask of all the unique rows in the DataFrame.

pub fn lazy(self): LazyFrame

Convert the DataFrame into a LazyFrame

pub fn null_count(self): DataFrame

Create a new DataFrame that shows the null counts per column.

pub fn partition_by(self, cols: [string], include_key: bool = false, stable: bool = false): [DataFrame] throws PolarsError

Split into multiple DataFrames partitioned by groups

pub fn pop(self): Column?

Removes the last column from the DataFrame and returns it, or None if it is empty.

pub fn rename(self, name: string, new_name: string) throws PolarsError

Rename a column in the DataFrame.

pub fn replace(self, name: string, new_column: Column) throws PolarsError

pub fn reverse(self): DataFrame

Get a DataFrame with all the columns in reversed order.

pub fn select_column(self, name: string): Column throws PolarsError

Select a single column by name.

pub fn select_columns(self, names: [string]): [Column] throws PolarsError

Selected multiple columns by name.

pub fn select_index(self, idx: int): Column?

pub fn shift(self, periods: int): DataFrame

Shift the values by a given period and fill the parts that will be empty due to this operation with Nones.

pub fn slice(self, offset: int, length: int): DataFrame

Slice the DataFrame along the rows.

pub fn sort(self, by: [string], descending: [bool] = [false], nulls_last: [bool] = [false], multithreaded: bool = true, maintain_order: bool = false, limit: int? = nil) throws PolarsError

[src]

pub fn sort(
    self,
    by: [string],
    descending: [bool] = [false],
    nulls_last: [bool] = [false],
    multithreaded: bool = true,
    maintain_order: bool = false,
    limit: int? = nil
) throws PolarsError {
    try self._sort(by, descending, nulls_last, multithreaded, maintain_order, limit);
}

Sort the DataFrame by column(s).

pub fn sql(self, query: string, table_name: string = "self"): DataFrame throws PolarsError

Execute a SQL query against the DataFrame.

pub fn tail(self, n: int): DataFrame

Get the tail of the DataFrame.

pub fn take(self, indices: [int] | UInt32Chunked): DataFrame throws PolarsError

[src]

pub fn take(self, indices: [int] | UInt32Chunked): DataFrame throws PolarsError {
    switch (let indices = indices.(type)) {
        case [int]:
            return try self._take_by_array(indices);
        case UInt32Chunked:
            return try self._take_by_chunked(indices);
    }
}

Take [DataFrame] rows by index values.

pub fn to_string(self): string

pub fn unique(self, subset: [string]? = nil, keep: UniqueKeepStrategy = .Any): DataFrame throws PolarsError

[src]

pub fn unique(
    self, subset: [string]? = nil, keep: UniqueKeepStrategy = .Any
): DataFrame throws PolarsError {
    return try self._unique(subset, keep as int);
}

Drop duplicate rows from a DataFrame.

pub fn vstack(self, other: DataFrame): DataFrame throws PolarsError

Concatenate a DataFrame to this DataFrame and return as newly allocated DataFrame.

pub fn write_csv(self, path: string, include_bom: bool = false, include_header: bool = true) throws PolarsError

Write a DataFrame to a CSV file.

pub fn write_parquet(self, path: string) throws PolarsError

Write a DataFrame to a Parquet file.