Project

class Project

Projects on Redivis are where analytical workflows are built and executed. All projects are owned by a user, and are made up of transforms, notebooks, and their output tables.

Constructors

MethodDescription

User$list_projects([max_results])

List all projects owned by a user.

User$project(project_reference)

Construct a new project instance that references a project owned by a user.

Examples

loadNamespace("redivis")

project <- redivis::user("imathews")$project("example_project_climate_analysis")
tables <- project$list_tables()

for (table in tables){
    # Properties will be populated with the table.list resource representation
    print(table$properties) 
    
    table$get()
    # Properties will now be populated with the table.get resource representation
    print(table$properties) 
}

project$table("join_lat_lon_output")$exists() # -> TRUE

Fields

properties

A named list containing the API resource representation of the project. This will be fully populated after calling Project$get(), and partially populated for projects created via User$list_projects. Otherwise will be NULL.

qualified_reference

The fully qualified reference for the project, which can be used in SQL queries or the REST API. E.g., imathews.example_project_climate_analysis:x7kh

scoped_reference

The canonical reference for the project, without the username qualifier. E.g.,: example_project_climate_analysis:x7kh

user

A reference to the User instance that constructed this project.

Methods

Check whether the project exists.

Get the project, populating the properties attribute on the current instance.

Project$list_tables([max_results])

List all tables in the project.

Project$query(query_string)

Create a query scoped to the project.

Project$table(table_reference)

Create a reference to a specific table within the project.

Last updated