Documentation/blog post: tutorial for downloading IPUMS extract #27#43
Open
gavinjqu wants to merge 8 commits into
Open
Documentation/blog post: tutorial for downloading IPUMS extract #27#43gavinjqu wants to merge 8 commits into
gavinjqu wants to merge 8 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #43 +/- ##
=======================================
Coverage 29.70% 29.70%
=======================================
Files 27 27
Lines 643 643
=======================================
Hits 191 191
Misses 452 452 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or 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
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.
Closes #27
This adds to
docs/src/tutorials.md, which is a walkthrough of the IPUMS extract API workflow withIPUMS.jl, modeled on the ipumsr R article.Overview: supported collections, API key setup, defining a microdata extract in JSON (weights, data quality flags, case selections),
extract_submit,extract_download, and reading the result into aDataFrameviaparse_ddi+load_ipums_extract. Ends with a full end-to-end script and aLimitations and roadmapsection.Out of scope: the NHGIS / aggregate-data flow. Planning to open a follow-up issue.
Note: a few claims would benefit from a second pair of eyes, specifically the IPUMS sample codes (
cps2018_03s/cps2019_03s), theAuthorizationheader format, and thecolmetadatakey strings used in the reading section. Also, the reading section pulls in a new dependency (CodecZlib) for.dat.gzdecompression, and I dropped the outer# Tutorialsheading since this is the only article on the page. I'm happy to revise anything if needed.