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.

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

Add documentation to load_variables() about datasets #557

Open
nathanckuhn opened this issue Feb 12, 2024 · 0 comments
Open

Add documentation to load_variables() about datasets #557

nathanckuhn opened this issue Feb 12, 2024 · 0 comments

Comments

@nathanckuhn
Copy link

First, thank you to all involved in developing this package!

For load_variables, there is no documentation for what the "dataset" acronyms mean.

I had to learn a lot more about the Census API & dig through this repository's issues before I found an answer. I believe most descriptions of these datasets can be found here: https://api.census.gov/data/

Could some text please be added to the load_variables documentation to provide the link and more context for newer users?

Example: The second paragraph under Details would be more informative if divided into decennial & non-decennial groups and rewritten like the following: (** Please check my work on this! I'm not an expert.)

Datasets available are as follows:

For the Decennial Census: "sf1", "sf2", "sf3", "sf4", "pl", "dhc", "dp", "ddhca", "as", "gu", "mp", "vi", "dpas", "dpgu", "dpmp", "dpvi", "dhcvi", "dhcgu", "dhcvi", "dhcas", "sf2profile", "sf3profile", "sf4profile", "cd110h", "cd110s", "cd110hprofile", "cd110sprofile", "sldh", "slds", "sldhprofile", "sldsprofile", "cqr", "cd113profile", "cd115profile", "cd116", "cd118", and "plnat".

For the American Community Survey: "acsse", "acs1", "acs3", "acs5", "acs1/profile", "acs3/profile", "acs5/profile", "acs1/subject", "acs3/subject", "acs5/subject", "acs1/cprofile", and "acs5/cprofile".

In both the decennial census and ACS, depending on the vintage: "aian", "aianprofile", "cd113", and "cd115".

For the title and description of each, search for the dataset name here: https://api.census.gov/data/
Exception, for ACS dataset names with a forward slash, search for each part separately (e.g., "acs1" and "profile").

** Please note I could not find "dhca" -- it is possible it is no longer provided through the API. If it still is, it would need different documentation.

Thank you again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant