From 0a38953de2e7f1969d487d850641f2f48f3cbe86 Mon Sep 17 00:00:00 2001 From: kmoscoe <165203920+kmoscoe@users.noreply.github.com> Date: Mon, 26 Aug 2024 11:01:52 -0700 Subject: [PATCH] Remove sections on finding DCID examples etc. and repoint to canonical doc (#486) * troubleshooting API * Revert to gerund Though the style guide says to just use imperatives, "get started" just sounds weird. Also this is more consistent with "troubleshooting" * repoint sections on finding DCs * add additional title --- api/web_components/index.md | 30 ++---------------------------- data_model.md | 9 ++++----- 2 files changed, 6 insertions(+), 33 deletions(-) diff --git a/api/web_components/index.md b/api/web_components/index.md index 41f8f6ac6..eeca223a0 100644 --- a/api/web_components/index.md +++ b/api/web_components/index.md @@ -82,35 +82,9 @@ places. Variables and places are identified by [Data Commons Identifiers](/glossary.html#dcid), or [DCID](/glossary.html#dcid)s. -To find the [DCID](/glossary.html#dcid) of a place or variable: +To look up a DCID for an entity or variable, see the different methods described in [this page](/data_model.html#find-dcid). -1. Browse all variables with the - [Data Commons Statistical Variable Explorer](https://datacommons.org/tools/statvar). - -2. Search for places and variables with the - [Data Commons Search](https://datacommons.org/search) page. - -3. Use the [Data Commons Knowledge Graph](https://datacommons.org/browser) to - understand the relationship between entities. - -### Finding DCIDs Examples - -#### Example #1: Finding places available for a variable - -Inspecting -[Health / Health Insurance (Household) / No Health Insurance / Households Without Health Insurance](https://datacommons.org/tools/statvar#sv=Count_Household_NoHealthInsurance) -shows us that the statistical variable `Count_Household_NoHealthInsurance` is -available in the `United States` ([DCID](/glossary.html#dcid): `country/USA`) at -`State`, `County`, and `City` levels. - - - -#### Example #2: Finding place DCIDs - -The Knowledge Graph [country/USA](https://datacommons.org/browser/country/USA) -page shows the [DCID](/glossary.html#dcid)s for all US states and territories. - - +To find places available for a statistical variable, see [this page](/data_mode.html#find-places). ## Styling diff --git a/data_model.md b/data_model.md index fba559614..b171233aa 100644 --- a/data_model.md +++ b/data_model.md @@ -1,11 +1,11 @@ --- layout: default -title: Key concepts +title: Key concepts and common tasks nav_order: 3 --- {: .no_toc} -# Key concepts +# Key concepts and common tasks Whether you're just exploring the data on [datacommons.org](http://datacommons.org), using the programmatic APIs, or contributing data, it's helpful to have a basic understanding of some of the key concepts in Data Commons. Use the following guidance: - If you are only using Data Commons interactive tools, Google Sheets, CSV download, or BigQuery, you should at least be familiar with [entities](#entity) and [statistical variables](#statistical-variable). You may wish to just skip directly to those sections. @@ -69,7 +69,7 @@ The type of a statistical variable is always the special sub-class [`Statistical A statistical variable can be simple, such as [`Total Population`](https://datacommons.org/browser/Count_Person){: target="_blank"}, or more complex, such as [`Hispanic Female Population`](https://datacommons.org/tools/statvar#Count_Household_NoHealthInsurance=&sv=Count_Person_Female_HispanicOrLatino){: target="_blank"}. Complex variables may be broken down into constituent parts, or not. -### Find places available for a statistical variable {#find-places} +### Task: Find places available for a statistical variable {#find-places} Note that not all statistical variables have observations for all places or other entities. To find out which places have data for a given variable, you can do the following: @@ -95,7 +95,7 @@ DCIDs are not restricted to entities; statistical variables also have DCIDs. For ![Stat Var Explorer]({{site.url}}/assets/images/dc/concept7.png){: width="900"} -### Find a DCID for an entity or variable {#find-dcid} +### Task: Find a DCID for an entity or variable {#find-dcid} Many Data Commons tools and APIs require that you provide a DCID as input for a query. There are a few ways to do this. @@ -144,7 +144,6 @@ Time series made up of many observations underlie the data available in the [Tim ![Timeline Explorer]({{site.url}}/assets/images/dc/concept11.png){: width="900"} - ## Provenance, Source, Dataset Every node and triple also have some important properties that indicate the origin of the data.