Reference

The redivis R package provides an interface to construct representations of Redivis entities and to create, modify, read, and delete them.

Resources are generally constructed by chaining together multiple constructor methods, reflecting the hierarchical nature of entities in Redivis. For example, to list all variables on table (which belongs to a dataset in an organization), we would write:

import redivis

variables = (
    redivis::organization("Demo")      # Returns an instance of an Organization
    $dataset("CMS 2014 Medicare Data"  # Returns an instance of a Dataset
    $table("Home health agencies")     # Returns an instance of a Table
    $list_variables()                  # Retuns a list of Variable instances
)

Interfaces

The redivis namespace. Provides constructor methods for most of the other classes.

Class representing a Redivis dataset. Provides constructor methods for Tables and Queries scoped to a given dataset, as well as methods for creating, deleting, and updating datasets.

Class representing a non-tabular file on Redivis.

Class representing a Redivis organization. Provides constructor methods for Datasets and Projects scoped to a given organization.

Class representing a Redivis project. Provides constructor methods for Tables and Queries scoped to a given project.

Class representing a running SQL query that references tables on Redivis.

Class representing a Redivis table. Numerous methods available for reading data from the table, as well as uploading data and metadata.

Class representing a Redivis user. Provides constructor methods for Datasets and Projects scoped to a given user.

Class representing a specific variable with a Table.

Environment variables

The following environment variables may be set to modify the behavior of the redivis-r client.

REDIVIS_API_TOKEN

If using this library in an external environment, you'll need set this env variable to your API token in order to authenticate.

Important: this token acts as a password, and should never be inlined in your code, committed to source control, or otherwise published.

REDIVIS_DEFAULT_PROJECT

If set, tables referenced via redivis::table() and unqualified table names in redivis::query() will be assumed to be within the default project.

Takes the form user_name.project_name. All notebooks on Redivis automatically set the default project to that notebook's project. Learn more about referencing resource >

REDIVIS_DEFAULT_DATASET

If set, tables referenced via redivis::table() and unqualified table names in redivis::query() will be assumed to be within the default dataset.

Takes the form owner_name.project_name. If both a default dataset and project are set, the default project will supersede the dataset. Learn more about referencing resource >

REDIVIS_TMPDIR

If set, this directory will be used to temporarily store data for disk-backed data objects (e.g., see Table$to_arrow_dataset). Otherwise, the default OS temp directory will be used.

Last updated