Rx.Explorer (rx v0.1.0)

Copy Markdown View Source

Bridge between Explorer.DataFrame and R data frames via Apache Arrow IPC.

Requires the optional {:explorer, "~> 0.11"} dependency.

Summary

Functions

from_r(object)

Converts an R data frame object to an Explorer.DataFrame.

from_r!(object)

Converts an R data frame object to an Explorer.DataFrame, raising on error.

to_r(arg)

Converts an Explorer.DataFrame to an R data frame, storing it in the R object store.

to_r!(arg)

Converts an Explorer.DataFrame to an R data frame, raising on error.

Functions

from_r(object)

Converts an R data frame object to an Explorer.DataFrame.

Returns {:ok, Explorer.DataFrame.t()} or {:error, term()}. Raises ArgumentError if object is not a %Rx.Object{}. Raises RuntimeError if Explorer is not installed.

from_r!(object)

Converts an R data frame object to an Explorer.DataFrame, raising on error.

Raises ArgumentError for non-%Rx.Object{} input. Raises Rx.Error if the R object cannot be decoded as a data frame.

to_r(arg)

Converts an Explorer.DataFrame to an R data frame, storing it in the R object store.

Returns {:ok, %Rx.Object{}} or {:error, term()}. Raises ArgumentError if df is not an Explorer.DataFrame. Raises RuntimeError if Explorer is not installed.

to_r!(arg)

Converts an Explorer.DataFrame to an R data frame, raising on error.

Raises ArgumentError for non-Explorer.DataFrame input. Raises Rx.Error if serialisation or transfer fails.