{"_id":"5984a480339eac000f54a76f","project":"55faf11ba62ba1170021a9a7","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":40,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"58458b4fba4f1c0f009692bb","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-12-05T15:44:15.650Z","from_sync":false,"order":6,"slug":"datasets-hub","title":"DATASETS HUB"},"user":"5613e4f8fdd08f2b00437620","githubsync":"","__v":5,"parentDoc":null,"updates":["5a9454acbec35c00121d3799","5a957e3a5e17cc0038ed9e62","5a9622b47dbee10012ed3925","5b132467bc90f5000319edd3","5b6c738ab02563000334ef88"],"next":{"pages":[],"description":""},"createdAt":"2017-08-04T16:44:48.934Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":31,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"* [Overview](#section-overview)\\n* [Choose your datasets](#section-choose-your-datasets)\\n* [Start your query](#section-start-your-query)\\n* [Start by searching through a dataset](#section-start-by-searching-through-a-dataset)\\n* [Start from an entity](#section-start-from-an-entity)\\n* [Filter by an entity's properties](#section-filter-by-an-entity-s-properties)\\n* [View the query results](#section-view-the-query-results)\\n* [Access data for use in your project](#section-access-data-for-use-in-your-project)\",\n  \"title\": \"On this page\"\n}\n[/block]\n##Overview\n\nLearn about selecting datasets for your query and filtering by metadata properties. Get an overview of your query results and use them in your projects on the Platform.\n\n##Choose your datasets\n\nOpen the Data Browser to display the datasets available for querying, including the TCGA GRCh38, TARGET, and CPTAC. Choose one or more datasets to query. Note that you can only query harmonized datasets together.\n\nNote that in order to use Controlled Data you need [Controlled Data access via the dbGaP](doc:dbgap-controlled-data-access).\n\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n##Start your query\nTo start your query, use either of these options.\n\n###Start by searching through a dataset\n\nTo search through a dataset you have selected you can build a query using from search terms. The intuitive, autocomplete search functionality uses your terms to suggest pre-built queries. Select a query and continue to edit it on the Data Browser canvas.\n\nFor more information, see [*Data Browser query: start by searching through a dataset](doc:data-browser-query-search-through-a-dataset).\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/05cff0d-data-browser-keywords-example.png\",\n        \"data-browser-keywords-example.png\",\n        946,\n        460,\n        \"#ba6246\"\n      ]\n    }\n  ]\n}\n[/block]\n###Start from an entity\n\nThe [entities](doc:about-metadata-for-datasets) of the datasets you selected are displayed on the Data Browser when you first open it, as shown below. Start your queries from a dataset's entities. Simply click on an entity, such as **Case** below, to start.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d8b78ca-qs-4.png\",\n        \"qs-4.png\",\n        1123,\n        508,\n        \"#f9f9f9\"\n      ]\n    }\n  ]\n}\n[/block]\nAdd entities by clicking on a previously added entity. A list of entities associated with the first one appears, as shown below. For instance, a **Case** can have associated **Files** (about the case), **Samples** (taken from the patient), and **Drug therapies** (given to the patient). Hover over an entity for more information.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d5e1456-qs-5.png\",\n        \"qs-5.png\",\n        1215,\n        672,\n        \"#575d77\"\n      ]\n    }\n  ]\n}\n[/block]\n##Filter by an entity's properties\n\nOnce you've selected an entity, you can filter by that entity's properties. Click **+ Add property** below each entity to add filters. Take advantage of the search box's partial matching functionality to generate a list of properties and values to help you get started.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/5ffbd78-qs-1.png\",\n        \"qs-1.png\",\n        296,\n        448,\n        \"#d88879\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\nNote that you can edit a property at any time by clicking the pencil icon. You will be unable to add more values for each property otherwise.\n\n##View the query results\n\nThe table below the Data Browser contains a list of UUIDs for the entities which match your query. This table 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.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/68fcfcc-qs-6.png\",\n        \"qs-6.png\",\n        1343,\n        808,\n        \"#ebeced\"\n      ],\n      \"caption\": \"View query results in table format.\"\n    }\n  ]\n}\n[/block]\nIf you selected multiple datasets across which to build your query, a visual representation of the distribution of your query results can be displayed instead of the table.\n\nBy clicking the **Analytics** option as shown below, you can see the contribution of each dataset towards the result of your query, plotted by entity.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/05701a5-clicking-analytics-to-see-plotted-results.png\",\n        \"clicking-analytics-to-see-plotted-results.png\",\n        1216,\n        714,\n        \"#ececef\"\n      ],\n      \"caption\": \"View the distribution of query results across datasets for each entity.\"\n    }\n  ]\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n##Access data for use in your project\n\nOnce you've built a query, you can access the resulting data for use in a project. Learn more about [accessing data from the Data Browser](doc:access-data-from-the-data-browser).\n\n<div align=\"right\"><a href=\"#top\">top</a></div>","excerpt":"<a href=\"query-datasets\" style=\"color:#132c56\">QUERY DATASETS</a> ><a href=\"about-the-data-browser\" style=\"color:#132c56\">About the Data Browser</a> > Data Browser feature query structure","slug":"data-browser-query-structure","type":"basic","title":"↳ Data Browser query structure"}

↳ Data Browser query structure

<a href="query-datasets" style="color:#132c56">QUERY DATASETS</a> ><a href="about-the-data-browser" style="color:#132c56">About the Data Browser</a> > Data Browser feature query structure

[block:callout] { "type": "warning", "body": "* [Overview](#section-overview)\n* [Choose your datasets](#section-choose-your-datasets)\n* [Start your query](#section-start-your-query)\n* [Start by searching through a dataset](#section-start-by-searching-through-a-dataset)\n* [Start from an entity](#section-start-from-an-entity)\n* [Filter by an entity's properties](#section-filter-by-an-entity-s-properties)\n* [View the query results](#section-view-the-query-results)\n* [Access data for use in your project](#section-access-data-for-use-in-your-project)", "title": "On this page" } [/block] ##Overview Learn about selecting datasets for your query and filtering by metadata properties. Get an overview of your query results and use them in your projects on the Platform. ##Choose your datasets Open the Data Browser to display the datasets available for querying, including the TCGA GRCh38, TARGET, and CPTAC. Choose one or more datasets to query. Note that you can only query harmonized datasets together. Note that in order to use Controlled Data you need [Controlled Data access via the dbGaP](doc:dbgap-controlled-data-access). <div align="right"><a href="#top">top</a></div> ##Start your query To start your query, use either of these options. ###Start by searching through a dataset To search through a dataset you have selected you can build a query using from search terms. The intuitive, autocomplete search functionality uses your terms to suggest pre-built queries. Select a query and continue to edit it on the Data Browser canvas. For more information, see [*Data Browser query: start by searching through a dataset](doc:data-browser-query-search-through-a-dataset). [block:image] { "images": [ { "image": [ "https://files.readme.io/05cff0d-data-browser-keywords-example.png", "data-browser-keywords-example.png", 946, 460, "#ba6246" ] } ] } [/block] ###Start from an entity The [entities](doc:about-metadata-for-datasets) of the datasets you selected are displayed on the Data Browser when you first open it, as shown below. Start your queries from a dataset's entities. Simply click on an entity, such as **Case** below, to start. [block:image] { "images": [ { "image": [ "https://files.readme.io/d8b78ca-qs-4.png", "qs-4.png", 1123, 508, "#f9f9f9" ] } ] } [/block] Add entities by clicking on a previously added entity. A list of entities associated with the first one appears, as shown below. For instance, a **Case** can have associated **Files** (about the case), **Samples** (taken from the patient), and **Drug therapies** (given to the patient). Hover over an entity for more information. [block:image] { "images": [ { "image": [ "https://files.readme.io/d5e1456-qs-5.png", "qs-5.png", 1215, 672, "#575d77" ] } ] } [/block] ##Filter by an entity's properties Once you've selected an entity, you can filter by that entity's properties. Click **+ Add property** below each entity to add filters. Take advantage of the search box's partial matching functionality to generate a list of properties and values to help you get started. [block:image] { "images": [ { "image": [ "https://files.readme.io/5ffbd78-qs-1.png", "qs-1.png", 296, 448, "#d88879" ], "border": true } ] } [/block] Note that you can edit a property at any time by clicking the pencil icon. You will be unable to add more values for each property otherwise. ##View the query results The table below the Data Browser contains a list of UUIDs for the entities which match your query. This table 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. [block:image] { "images": [ { "image": [ "https://files.readme.io/68fcfcc-qs-6.png", "qs-6.png", 1343, 808, "#ebeced" ], "caption": "View query results in table format." } ] } [/block] If you selected multiple datasets across which to build your query, a visual representation of the distribution of your query results can be displayed instead of the table. By clicking the **Analytics** option as shown below, you can see the contribution of each dataset towards the result of your query, plotted by entity. [block:image] { "images": [ { "image": [ "https://files.readme.io/05701a5-clicking-analytics-to-see-plotted-results.png", "clicking-analytics-to-see-plotted-results.png", 1216, 714, "#ececef" ], "caption": "View the distribution of query results across datasets for each entity." } ] } [/block] <div align="right"><a href="#top">top</a></div> ##Access data for use in your project Once you've built a query, you can access the resulting data for use in a project. Learn more about [accessing data from the Data Browser](doc:access-data-from-the-data-browser). <div align="right"><a href="#top">top</a></div>