Skip to content

Interacting with the Platform

The Rose platform is designed to be simple and clean. A powerful tool for data visualization, transformation, and analysis.

Interface

Rose Interface

The Rose Platform is divided into 5 areas:

  1. Notebook menu: access search, add modules, and create new notebooks
  2. Notebook pane: main interface for viewing, analyzing, and transforming your data
  3. Navigation menu: switch between your workspace, the sharing center, data marketplace, documentation, and the profile menu
  4. Edit/View mode toggle: switch between edit mode (which allows you to add/change modules) and view mode (which presents a clean visualization)
  5. Profile menu: view your account information, swap between dark and light mode, and logout.
  6. Support: talk to a member of the Rose Team in real-time for help

Notebook Menu

On the Rose Platform, you can hover over a menu icon to view the title.

Notbook Menu

  1. Search
  2. Code module
  3. Markdown module
  4. Query module
  5. Import/Upload File
    1. Import CSV/PDF
  6. New notebook
  7. Save notebook
  8. Duplicate notebook
  1. Workspace: Create new notebooks, search for data, and perform analyses.
  2. Sharing: Share datasets and notebooks both internally and externally with customized permissioning.
  3. Marketplace: Buy and sell new datasets
  4. Profile: View your account information and change your password.

Notebook

Think of a notebook like a file. It has a name (this notebook's name is learning.rose.interacting.with.the.platform), is made up of modules, and is the place where you do all of your work. Notebooks can be saved, shared, and searched for on Rose for future use and collaboration.

Rose Notebook

  1. Notebook title: set when you save a notebook for the first time
  2. Markdown module: give your notebook context and style
  3. Code module: run and transform rosecodes
  4. Chart area: interactive visualization of your analyses, see: Visualizing Data in Rose

How to Save a notebook

  1. Click on the Save button on the bottom left menu
  2. If it is the first time the notebook is saved, give the notebook a name. Note: Notebook names cannot contain spaces.
  3. Notebooks autosave frequently, but best practice is to save after any major changes.

How to Share a notebook

Sharing Demo

  1. Click the Sharing button in the navigation bar at the top of your Rose Notebook to open the Sharing Center.
  2. Search for the user you wish to share your notebook with and click View
  3. Search (or copy and paste) the notebook name you wish to share.
    1. Note: do not include the entire URL, just the notebook name.
  4. Click Share
    1. Select what level of permission you want to share with the user:
      1. Don't share underlying data
      2. Share all the underlying data
    2. Click Share
  5. You should see a message that your notebook was successfully shared!

Modules

Modules are the building blocks of Rose notebooks. They allow you to visualize, transform, and explain your data.

There are three kinds of modules in Rose: Code, Markdown, and Query modules.

How to run a module

There are two easy ways to run a module. By clicking the RUN button under the module or by using the keyboard shortcut shift + enter while the module is activated.

Code Module

Code modules are where you run rosecodes to visualize and apply transformations to transform your data.

See: Visualizing Data in Rose

See: Transformations in Rose

Markdown Module

Markdown modules are where you write comments, descriptions, titles, and any other text, like you would in Word or a Notes app. They can be formatted using markdown notation to improve readability and structure.

See: Markdown in Rose

Query Module

The query module allows users to run SQL queries directly on their database from Rose.

  1. Select a database connection from the dropdown above the top right of the module or + Add connection
    select a database
  2. Write your SQL query.
    1. Note: you will need to know the schema of the database you are trying to query.
  3. shift + enter to run your query. Results will be returned as a map. running a sql query
  4. You can save your query as a rosecode using Logic.
    1. Still in the query module, run <new_rosecode> = <query>
    2. You will now be able to access the map and apply Rose transformations in a code module by running <new_rosecode>. query push logic

Rosecodes

Whereas modules are the building blocks of Rose Notebooks, rosecodes are the concrete that those blocks consist of. Rosecodes are the labels, or pointers, to information in the Rose Pltaform. They can reference timeseries, maps, or logic and can be run in the Code Module. Naming of rosecodes is customizable by organization or individual, by establishing naming conventions.

Naming Conventions

Here at Rose HQ we follow the basic syntax for naming:

location.statistic.substatistic.modifier(s).units.frequency.source.subsource.user.date

This may seem confusing at first, but each rosecode should read as a human-understandable concept. This naming convention is flexible and can be simplified throughout the research process by using Logic.

For detailed explanations, examples, and common abbrevations, see: Naming Conventions

Support

Have a question? Experiencing an issue? Need help with finding something on Rose? Want to send us some feedback? Contact a member of the Rose Team through the support button in the bottom right corner.

Rose Intercom Support