Add brief description of RSI model to quickstart #492
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Though the style guide says to just use imperatives, "get started" just sounds weird. Also this is more consistent with "troubleshooting"
keyurva
reviewed
Aug 29, 2024
custom_dc/quickstart.md
Outdated
| ... | ... | ... | | ||
|
|
||
| There are a few important things to note: | ||
| - There are only 3 columns: one representing a place (`countryAlpha3Code`); one representing a date (`date`); and one representing a [_statistical variable_](/glossary.html#variable), which is a Data Commons concept for a metric: `average_annual_wage` and `gender_wage_gap`. (Actually, there can be any number of statistical variable columns -- but no other types of additional columns -- and these two CSV files could be combined into one.) |
There was a problem hiding this comment.
We should also explain the countryAlpha3Code part in brief or point to a section that does.
custom_dc/quickstart.md
Outdated
|
|
||
| There are a few important things to note: | ||
| - There are only 3 columns: one representing a place (`countryAlpha3Code`); one representing a date (`date`); and one representing a [_statistical variable_](/glossary.html#variable), which is a Data Commons concept for a metric: `average_annual_wage` and `gender_wage_gap`. (Actually, there can be any number of statistical variable columns -- but no other types of additional columns -- and these two CSV files could be combined into one.) | ||
| - Every row is a separate [_observation_](/glossary.html#observation), or a value of the variable for a given place and time. |
There was a problem hiding this comment.
This is true of the 2 sample files but if they have multiple variable columns, then each row could represent multiple observations.
There was a problem hiding this comment.
OK, this is related to the second bullet where I mention that; added another mention, PTAL.
custom_dc/quickstart.md
Outdated
| - There are only 3 columns: one representing a place (`countryAlpha3Code`); one representing a date (`date`); and one representing a [_statistical variable_](/glossary.html#variable), which is a Data Commons concept for a metric: `average_annual_wage` and `gender_wage_gap`. (Actually, there can be any number of statistical variable columns -- but no other types of additional columns -- and these two CSV files could be combined into one.) | ||
| - Every row is a separate [_observation_](/glossary.html#observation), or a value of the variable for a given place and time. | ||
|
|
||
| This is the scheme to which your data must conform if you want to take advantage of Data Commons' simple import facility. If your data doesn't follow this model, you'll need to do some more work to prepare or configure it for correct loading. (That topic is discussed in detail in [Preparing and loading your data](custom_data.md).) |
There was a problem hiding this comment.
Wondering if we should use the word "format" vs "scheme" do describe the shape of the data. WDYT?
There was a problem hiding this comment.
Sure, if you think that's better.
glossary.md
Outdated
| ### [Statistical Variable](https://datacommons.org/browser/StatisticalVariable){: target="_blank"} | ||
| {: #variable} | ||
|
|
||
| Any type of metric, statistic, or measure that can be measured at a place and time. Examples include [median income of persons older than 16](https://datacommons.org/browser/Median_Income_Person_16OrMoreYears){: target="_blank"}, [number of female high school graduates aged 18 to 24](https://datacommons.org/browser/Count_Person_18To24Years_EducationalAttainmentHighSchoolGraduateIncludesEquivalency_Female){: target="_blank"}, [unemployment rate](https://browser.datacommons.org/browser/UnemploymentRate_Person){: target="_blank"}, or [percentage of persons with diabetes](https://browser.datacommons.org/browser/Percent_Person_WithDiabetes){: target="_blank"}. A complete list of variables can be found in the [Knowledge Graph](https://datacommons.org/browser/StatisticalVariable){: target="_blank"}. |
There was a problem hiding this comment.
So it's typically associated with a place and time but in the more generic sense, it can be associated with any entity in the graph (e.g. business unit, power plant, etc.) and time.
There was a problem hiding this comment.
So I actually didn't write or update this, I only put it in alphabetical order. :-) But updated as you suggest.
keyurva
approved these changes
Aug 29, 2024
custom_dc/quickstart.md
Outdated
| - There are only 3 columns: one representing a place (`countryAlpha3Code`); one representing a date (`date`); and one representing a [_statistical variable_](/glossary.html#variable), which is a Data Commons concept for a metric: `average_annual_wage` and `gender_wage_gap`. (Actually, there can be any number of statistical variable columns -- but no other types of additional columns -- and these two CSV files could be combined into one.) | ||
| - Every row is a separate [_observation_](/glossary.html#observation), or a value of the variable for a given place and time. | ||
| - There are only 3 columns: one representing a place (`countryAlpha3Code`, a [special Data Commons place type](/custom_dc/custom_data.html#special-names)); one representing a date (`date`); and one representing a [_statistical variable_](/glossary.html#variable), which is a Data Commons concept for a metric: `average_annual_wage` and `gender_wage_gap`. (Actually, there can be any number of statistical variable columns -- but no other types of additional columns -- and these two CSV files could be combined into one.) | ||
| - Every row is a separate [_observation_](/glossary.html#observation), or a value of the variable for a given place and time. In the case where multiple statistical variable columns, each row would, of course, consist of multiple observations. |
There was a problem hiding this comment.
nit: Sentence needs some rewording? "In the case where there are multiple..." or something along those lines.
There was a problem hiding this comment.
Oops, sorry, yes. Thanks for catching.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also added a note to the workflow, and renamed the "custom data" page to be clearer about what it's about.