Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit column descriptions on Datasets page #263

Merged
merged 4 commits into from
Aug 23, 2023
Merged

Edit column descriptions on Datasets page #263

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9e78dda
Add comment re: consistent across all datasets
Aug 22, 2023
2432296
Edit inconsistencies in descriptions
Aug 22, 2023
eb83eca
Add descriptions for year columns
Aug 22, 2023
be89fc7
Merge branch 'develop' into column_descriptions_datasets_page
pletale Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 30 additions & 23 deletions docs/source/datasets/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ The following columns are included in this dataset:
- Notes
* - Unique simulant ID
- :code:`simulant_id`
- Not affected by noise functions; intended use is "ground truth" for testing and validation.
- Not affected by noise functions; intended use is "ground truth" for testing and validation; consistent across all
datasets.
* - Unique household ID
- :code:`household_id`
- Not affected by noise functions; intended use is "ground truth" for testing and validation; consistent across all
Expand Down Expand Up @@ -106,12 +107,12 @@ The following columns are included in this dataset:
- Binary; "male" or "female".
* - Race/ethnicity
- :code:`race_ethnicity`
- The exhaustive and mutually exclusive categories for the single composite "race/ethnicity" indicator are as follows:
White; Black; Latino; American Indian and Alaskan Native (AIAN); Asian; Native Hawaiian and Other Pacific Islander (NHOPI); and
Multiracial or Some Other Race.
- The categories for the single composite "race/ethnicity" field are as follows:
"White"; "Black"; "Latino"; "American Indian and Alaskan Native (AIAN)"; "Asian"; "Native Hawaiian and Other Pacific Islander (NHOPI)"; and
"Multiracial or Some Other Race".
* - Year
- :code:`year`
- Metadata that would not be collected directly; not affected by noise functions.
- Year in which data were collected; metadata that would not be collected directly; not affected by noise functions.

American Community Survey (ACS)
-------------------------------
Expand All @@ -136,7 +137,8 @@ The following columns are included in this dataset:
- Notes
* - Unique simulant ID
- :code:`simulant_id`
- Not affected by noise functions; intended use is "ground truth" for testing and validation.
- Not affected by noise functions; intended use is "ground truth" for testing and validation; consistent across all
datasets.
* - Unique household ID
- :code:`household_id`
- Not affected by noise functions; intended use is "ground truth" for testing and validation; consistent across all
Expand Down Expand Up @@ -196,9 +198,9 @@ The following columns are included in this dataset:
- Binary; "male" or "female"
* - Race/ethnicity
- :code:`race_ethnicity`
- The exhaustive and mutually exclusive categories for the single composite "race/ethnicity" indicator are as follows:
White; Black; Latino; American Indian and Alaskan Native (AIAN); Asian; Native Hawaiian and Other Pacific Islander (NHOPI); and
Multiracial or Some Other Race.
- The categories for the single composite "race/ethnicity" field are as follows:
"White"; "Black"; "Latino"; "American Indian and Alaskan Native (AIAN)"; "Asian"; "Native Hawaiian and Other Pacific Islander (NHOPI)"; and
"Multiracial or Some Other Race".

Current Population Survey (CPS)
-------------------------------
Expand All @@ -223,7 +225,8 @@ The following columns are included in this dataset:
- Notes
* - Unique simulant ID
- :code:`simulant_id`
- Not affected by noise functions; intended use is "ground truth" for testing and validation.
- Not affected by noise functions; intended use is "ground truth" for testing and validation; consistent across all
datasets.
* - Unique household ID
- :code:`household_id`
- Not affected by noise functions; intended use is "ground truth" for testing and validation; consistent across all
Expand Down Expand Up @@ -266,9 +269,9 @@ The following columns are included in this dataset:
- Binary; "male" or "female"
* - Race/ethnicity
- :code:`race_ethnicity`
- The exhaustive and mutually exclusive categories for the single composite "race/ethnicity" indicator are as follows:
White; Black; Latino; American Indian and Alaskan Native (AIAN); Asian; Native Hawaiian and Other Pacific Islander (NHOPI); and
Multiracial or Some Other Race.
- The categories for the single composite "race/ethnicity" field are as follows:
"White"; "Black"; "Latino"; "American Indian and Alaskan Native (AIAN)"; "Asian"; "Native Hawaiian and Other Pacific Islander (NHOPI)"; and
"Multiracial or Some Other Race".



Expand All @@ -294,7 +297,8 @@ The following columns are included in this dataset:
- Notes
* - Unique simulant ID
- :code:`simulant_id`
- Not affected by noise functions; intended use is "ground truth" for testing and validation.
- Not affected by noise functions; intended use is "ground truth" for testing and validation; consistent across all
datasets.
* - Unique household ID
- :code:`household_id`
- Not affected by noise functions; intended use is "ground truth" for testing and validation; consistent across all
Expand Down Expand Up @@ -334,12 +338,12 @@ The following columns are included in this dataset:
- Binary; "male" or "female"
* - Race/ethnicity
- :code:`race_ethnicity`
- The exhaustive and mutually exclusive categories for the single composite "race/ethnicity" indicator are as follows:
White; Black; Latino; American Indian and Alaskan Native (AIAN); Asian; Native Hawaiian and Other Pacific Islander (NHOPI); and
Multiracial or Some Other Race.
- The categories for the single composite "race/ethnicity" field are as follows:
"White"; "Black"; "Latino"; "American Indian and Alaskan Native (AIAN)"; "Asian"; "Native Hawaiian and Other Pacific Islander (NHOPI)"; and
"Multiracial or Some Other Race".
* - Year
- :code:`year`
- Metadata that would not be collected directly; not affected by noise functions.
- Year in which benefits were received; metadata that would not be collected directly; not affected by noise functions.


Social Security Administration
Expand Down Expand Up @@ -368,7 +372,8 @@ The following columns are included in this dataset:
- Notes
* - Unique simulant ID
- :code:`simulant_id`
- Not affected by noise functions; intended use is "ground truth" for PRL tracking.
- Not affected by noise functions; intended use is "ground truth" for testing and validation; consistent across all
datasets.
* - First name
- :code:`first_name`
-
Expand Down Expand Up @@ -418,7 +423,8 @@ The following columns are included in these datasets:
- Notes
* - Unique simulant ID
- :code:`simulant_id`
- Not affected by noise functions; intended use is "ground truth" for testing and validation.
- Not affected by noise functions; intended use is "ground truth" for testing and validation; consistent across all
datasets.
* - Unique household ID
- :code:`household_id`
- Not affected by noise functions; intended use is "ground truth" for testing and validation; consistent across all
Expand Down Expand Up @@ -485,7 +491,7 @@ The following columns are included in these datasets:
- Possible values are "W2" or "1099".
* - Tax year
- :code:`tax_year`
- Metadata that would not be collected directly; not affected by noise functions.
- Year for which tax data were collected; metadata that would not be collected directly; not affected by noise functions.


Tax form: 1040
Expand All @@ -506,7 +512,8 @@ The following columns are included in this dataset:
- Notes
* - Unique simulant ID
- :code:`simulant_id`
- Not affected by noise functions; intended use is "ground truth" for testing and validation.
- Not affected by noise functions; intended use is "ground truth" for testing and validation; consistent across all
datasets.
* - Unique household ID
- :code:`household_id`
- Not affected by noise functions; intended use is "ground truth" for testing and validation; consistent across all
Expand Down Expand Up @@ -594,4 +601,4 @@ The following columns are included in this dataset:
- Individual Taxpayer Identification Number (ITIN) if no SSN
* - Tax year
- :code:`tax_year`
- Metadata that would not be collected directly; not affected by noise functions.
- Year for which tax data were collected; metadata that would not be collected directly; not affected by noise functions.