Concise name updates for StatVars_Batch 1#1218
Concise name updates for StatVars_Batch 1#1218mandelapro wants to merge 1 commit intodatacommonsorg:mainfrom
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello @mandelapro, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the overall clarity and consistency of statistical variable definitions within the system. By systematically updating the 'name' and 'description' fields across multiple data definition files, the changes aim to provide more precise and user-friendly labels for various statistical indicators. This effort is part of a broader initiative to improve data discoverability and interpretation. Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request aims to improve naming consistency for statistical variables by adding name and description fields. While this is a valuable effort, the changes introduce a significant number of critical errors, including syntax issues that will break parsing, and logical inconsistencies where names and descriptions do not match the variable IDs. I have highlighted several instances of copy-paste errors, incorrect descriptions, and malformed node definitions. These issues must be addressed to ensure the integrity and usability of the data. I recommend a thorough review of all changes to correct these widespread problems.
| name: "Monthly mean income of employed persons aged 14 years and over in the accommodation and food sector" | ||
| description: "The monthly mean income of employed people aged 14 years and over in the accommodation and food sector from their main job" |
There was a problem hiding this comment.
The name and description here are for the 'accommodation and food sector', but the dcid Monthly_Mean_Income_Person_Years14Onwards_AdminSocialServiceEducation_Employed_MainJob is for 'AdminSocialServiceEducation'. This is a critical copy-paste error that misrepresents the data.
name: "Monthly mean income of employed persons aged 14 years and over in the public administration, defense, social security, education, human health and social services sector"
description: "The monthly mean income of employed people aged 14 years and over in the public administration, defense, social security, education, human health and social services sector from their main job"
| name: "Food baskets delivered to households in emergency care" | ||
| description: "The number of food baskets delivered to households in emergency care" |
There was a problem hiding this comment.
The name and description refer to 'number of food baskets', but the node's measuredProperty is amount and populationType is Food. The original name was 'Kilograms of food...'. This is an incorrect update, as it changes the meaning of the variable from a weight/amount to a count.
| @@ -1,30 +1,33 @@ | |||
|
|
|||
| Node: dcid:StandardError_Person_Children_WithAsthma | |||
| name: "asthma Prevalence Standard Error in Children | |||
There was a problem hiding this comment.
This line is missing a closing quote, which is a syntax error that will cause parsing to fail. Additionally, 'asthma' should be capitalized for consistency with other names and medical terminology.
name: "Asthma Prevalence Standard Error in Children"
| literacyStatus: dcid:Illiterate | ||
|
|
||
| Node: dcid:Count_Person_10OrMoreYears_Female_Literate | ||
| name: "Illiterate Female Population Aged 10+ Years" |
There was a problem hiding this comment.
The name 'Illiterate Female Population Aged 10+ Years' contradicts the dcid Count_Person_10OrMoreYears_Female_Literate. This appears to be a copy-paste error. The name should reflect that this variable is for literate females. Similar critical mismatches are present on lines 195 and 205.
name: "Literate Female Population Aged 10+ Years"
| name: "Public School Nursery Students" | ||
| description: "The number of students enrolled in nursery programs in public schools" |
There was a problem hiding this comment.
The dcid Count_Student_PreKindergarten_PublicSchool indicates this node is for pre-kindergarten students, but the name and description refer to 'Nursery'. This is a critical mismatch that will lead to incorrect data interpretation. Please update the name and description to refer to pre-kindergarten. Similar mismatches exist on lines 552-553 and 562-563.
name: "Public School Pre-K Students"
description: "The number of students enrolled in pre-kindergarten programs in public schools"
| name: “Food Delivered to Extractive Families” | ||
| description: "The amount of food delivered to extractive families |
There was a problem hiding this comment.
There are syntax errors here. The name uses curly quotes (“... ”) instead of straight quotes ("..."), and the description is missing a closing quote. These will cause parsing errors. Please use straight double quotes and ensure they are properly closed. This issue is present in multiple places in this file (e.g., lines 68-69, 168, 421).
name: "Food Delivered to Extractive Families"
description: "The amount of food delivered to extractive families"
|
|
||
| Node: dcid:Count_Household_ReceivedFoodBasket_FishingFamily | ||
| name: "Fishing Families Receiving Food Baskets" | ||
| description: "The Number of food baskets that were destined for fishing families" |
There was a problem hiding this comment.
The description 'The Number of food baskets that were destined for fishing families' does not match the node Count_Household_ReceivedFoodBasket_FishingFamily. The description is for destined baskets, but the node is for households that received baskets. This is a critical error that misrepresents the data. Similar description mismatches are present on lines 202, 257, 312, and 323.
description: "The number of fishing family households that received food baskets"
|
|
||
| Node: dcid:Count_Person_BrazilIndigneous | ||
| name: "Brazil Indigenous Population" | ||
| description: "The number of people identified as Brazil Indigneous race" |
There was a problem hiding this comment.
There is a typo in 'Indigneous'; it should be 'Indigenous'. This typo appears in multiple places within this file (e.g., lines 123, 615, 626). Please correct it throughout for consistency and accuracy.
description: "The number of people identified as Brazil Indigenous race"
|
|
||
| Node: dcid:Annual_Amount_Emissions_OxidesOfNitrogen_AsAFractionOf_Count_Person | ||
| name: "Annual nitrogen oxide emissions per person" | ||
| description: "The annual amount of oxides of nitrogen emissions measured relative to The number of people" |
There was a problem hiding this comment.
There is an inconsistent capitalization in the description. The word 'The' should be lowercase to maintain consistency with other descriptions in the file. A similar issue exists on line 120.
description: "The annual amount of oxides of nitrogen emissions measured relative to the number of people"
|
|
||
| Node: dcid:Count_Person_16To19Years | ||
| name: "Persons Aged 16–19" | ||
| description: "The Number of people whose age is between 16 and 19 years" |
There was a problem hiding this comment.
The word 'Number' is capitalized at the beginning of the description. For consistency with standard sentence case in descriptions, it should be lowercase. This applies to other descriptions in this file as well (lines 13, 22, 31, 40, 49).
description: "The number of people whose age is between 16 and 19 years"
1 participant
Batch 1 update for StatVar concise naming consistency.