foundry (version 0.13.0)

datasets.read_table: Reads a tabular Foundry dataset as data.frame or an Apache Arrow Table.

Description

Reads a tabular Foundry dataset as data.frame or an Apache Arrow Table.

Usage

datasets.read_table(
  alias,
  columns = NULL,
  row_limit = NULL,
  format = "data.frame"
)

Value

A data.table or an Arrow Table

Arguments

alias

The alias representing the Dataset. The Dataset must be tabular, i.e. have a schema.

columns

The subset of columns to retrieve.

row_limit

The maximum number of rows to retrieve.

format

The output format, can be 'arrow' or 'data.frame'.

Column types

Note that types may not match exactly the Foundry column types. See https://arrow.apache.org/docs/r/articles/arrow.html for details on type conversions from an arrow Table to a data.frame.

Examples

if (FALSE) {
# Download a subset of a tabular Dataset
df <- datasets.read_table("my_input", columns = c("columnA", "columnB"), row_limit = 1000)
}