Data Browser features

🚧

On this page:

[ 1 ] Dataset name](#dataset-name)
[ 2 ] Query name](#query-name)
[ 3 ] Queries](#queries)
[ 4 ] Save a query](#save-a-query)
[ 5 ] The Search Box](#search)
[ 6 ] Count](#count)
[ 7 ] Clear All](#clear-all)
[ 8 ] Copy files to project](#copy-files-to-project)
[ 9 ] Table of results: List view](#table-of-results)
[ 10 ] Table of results: Details view](#details-view)
[ 11 ] Table of results: Analytics view](#distribution-graphs)
[ 12 ] Export query results](#export-query-results)

1296

[ 1 ] Dataset name

The name of the dataset you are querying is on the left side of the top navigation bar. In the image above, you are querying the TCGA dataset.

To clear your canvas and switch to another dataset (e.g. CCLE), simply click on the visible dataset name (e.g. TCGA). This opens a dialog box in which you can select the alternate dataset.

[ 2 ] Query name

The name of your query is also on the left side of the top navigation bar. This defaults to New query if your query is unsaved.

[ 3 ] Create new query

Click to delete all previous queries and open a new query canvas.


##[ 4 ] Queries

Click on Queries to reveal different actions relating to queries, as shown above.

Choose to open a previously saved query, open an example query provided by the Cavatica team, or save your current query.

Learn more about:


##[ 5 ] Save a query

You can save any query generated in the Data Browser. Note that empty canvases cannot be saved as queries.

To save a query:

  1. Click Queries on the top right of the Data Browser canvas.
  2. Select Save from the drop-down menu.
  3. In the pop-up window that appears, you can name and, if you wish, add a brief description of your query.
  4. Then click Save as new query.

All saved queries can be accessed by selecting Open saved from the Queries drop-down menu.

Learn more about accessing existing queries.


##[ 6 ] The Search Box

Click on Search by ID to reveal the search box. The search box allows you to search by UUID, ID (TCGA Barcodes), or file name.

You can enter more than one UUID, ID (TCGA Barcode), or file name (separated by commas) into the search box and click Search.

984

For instance, you can search for TCGA-OR-A5JW-01A-11D-A29I-10_Illumina.bam. This will populate the Data Browser with a query starting from the file TCGA-OR-A5JW-01A-11D-A29I-10_Illumina.bam. You can use this as the starting point of your query.

If you mix two types of search terms (such as a UUID and file name), you will be asked to choose one before proceeding.

[ 7 ] Copy files to project

The +Copy files to project button allows you to copy files that satisfy your query to your desired project. Learn more about accessing data for use in your project.


##[ 8 ] Count

The Count feature quantifies the scope of the data returned by your query.

A count card at the bottom of the Data Browser displays the entity and number of instances of that entity that satisfy your query. For example, the count card for Case shown below displays how many cases are returned by this specific query.

610

The number of entities returned changes as you add filters to your query. The count cards at the bottom of the page gray out to let you know the represented quantities need to be refreshed.

To refresh the number of instances of each entity returned by your query, click the circular arrows next to the count cards.

[ 9 ] Export query results

Export query results as a CSV, JSON, or XML file from this table by clicking Export. All query results are exported simultaneously but are separated into a different file for each branch. You can only export up to 3000 rows from the table results for each branch.

[ 10 ] Table of results: List view

The table below the Data Browser contains further details about your query. The Listview displays a list of UUIDs for the entities which match your query. This allows you to review returned results, but it does not allow you to select or filter results. All selection and filtering have to be done via the query on the Data Browser canvas.

[ 11 ] Table of results: Details view

The table below the Data Browser contains further details about your query. The Details view displays details of the selected entity in the context of your query, as shown below for the Sample 1 entity of this query. The lefthand column, Connections, displays the inbound and outbound connections for the selected entity in the context of your query. The middle column displays a list of UUIDs corresponding to the selected entity that match your query. Click on any one UUID in the middle column to view its corresponding metadata in the rightmost column.

1362

[ 12 ] Table of results: Analytics view

The table below the Data Browser contains further details about your query. The Analytics view displays the distributions of the members of each entity, as shown below for this query.

These graphs are an alternative way to visualize query results and reflect the same information as is displayed in the table. Note that currently only pre-defined, selectable values of a property can be visualized.

876