You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improve per-variable property description for custom DC (#566)
* Revert to gerund
Though the style guide says to just use imperatives, "get started" just sounds weird. Also this is more consistent with "troubleshooting"
* merge
* merge
* stable release
* removed reference to fork
* updated procedures
* wee corrections
* recorrect
* wee changes
* wee changes
* remove branch sync procedures
* corrections from Hannah
* first revisions
* more revisions
* more work
* first cut of variable-per-column rewrite
* more work
* more work
* more work
* restore changes
* more changes
* more changes
* more changes
* more changes
* updates to json spec
* more edits
* multiple directories
* more changes
* more changes
* more edits
* remove headings from TOC
* minor edits
* more edits
* remove wrong image reference
* remove more headings from TOC
* revisions per Ajai and a new diagram
* remove image, replace by text
* mention that node and field order in MCF do not matter
* added mention of required option for subdirs
* added note about MCF
* move feedback from index page to FAQ
* added info on stat var groups
* wee fixes
* make feedback links nicer
* added detail about measuredProperty in variable per column
* fix typo
* revert output directory change
Copy file name to clipboardExpand all lines: custom_dc/custom_data.md
+21-3Lines changed: 21 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -566,7 +566,9 @@ You must specify the provenance details under `sources.provenances`; this field
566
566
{: #observation-properties}
567
567
observationProperties (implicit schema only)
568
568
569
-
: Optional: Additional information about each contained in the CSV file. Currently, the following properties are supported:
569
+
: Optional: Additional information about each variable contained in the CSV file. Whatever setting you specify will apply to all variables in the file. (If you need different properties among variables, put your variables in different CSV files.)
570
+
571
+
Currently, the following properties are supported:
570
572
-[`unit`](/glossary.html#unit): The unit of measurement used in the observations. This is a string representing a currency, area, weight, volume, etc. For example, `SquareFoot`, `USD`, `Barrel`, etc.
571
573
-[`measurementPeriod`](/glossary.html#observation-period): The period of time in which the observations were recorded. This must be in ISO duration format, namely `P[0-9][Y|M|D|h|m|s]`. For example, `P1Y` is 1 year, `P3M` is 3 months, `P3h` is 3 hours.
572
574
-[`measurementMethod`](/glossary.html#measurement-method): The method used to gather the observations. This can be a random string or an existing DCID of [`MeasurementMethodEnum`](https://datacommons.org/browser/MeasurementMethodEnum){: target="_blank"} type; for example, `EDA_Estimate` or `WorldBankEstimate`.
@@ -601,7 +603,7 @@ description
601
603
602
604
properties
603
605
604
-
: Additional Data Commons properties associated with this variable. This section is analogous to the fields specified in an[MCF Node definition](#mcf).
606
+
: Additional Data Commons properties associated with this variable. The properties are any property required or optional in the[MCF Node definition](#mcf) of a variable. The value of the property must be a DCID.
605
607
606
608
Each property is specified as a key:value pair. Here are some examples:
607
609
@@ -614,6 +616,23 @@ Each property is specified as a key:value pair. Here are some examples:
614
616
}
615
617
```
616
618
619
+
Note that the `measuredProperty` property has an effect on the display: if it is not set for any variable, the importer assumes that it is different for every defined variable, so that each variable will be shown in a different chart in the UI tools. If you would like multiple variables to show up in the same chart, be sure to set this property on all of the relevant variables, to the same (DCID) value. For example, if you wanted `Adult_curr_cig_smokers_female` and `Adult_curr_cig_smokers_male` to appear on the same Timeline chart, set `measuredProperty` to a common property of the two variables, for example [`percent`](https://datacommons.org/browser/percent){: target="_blank"}.
620
+
621
+
```json
622
+
"variables": {
623
+
"Adult_curr_cig_smokers": {
624
+
"properties": {
625
+
"measuredProperty": "percent"
626
+
}
627
+
},
628
+
"Adult_curr_cig_smokers_female": {
629
+
"properties": {
630
+
"measuredProperty": "percent"
631
+
}
632
+
}
633
+
}
634
+
```
635
+
617
636
group
618
637
619
638
: By default, the Statistical Variables Explorer will display all custom variables as a group called "Custom Variables". You can use this option to create one or more custom group names and assign different variables to groups. The value of the `group` option is used as the heading of the group. For example, in the sample data, the group name `OECD` is used to group together the two variables from the two CSV files:
0 commit comments