Skip to content

Documentation/blog post: tutorial for downloading IPUMS extract #27#43

Open
gavinjqu wants to merge 8 commits into
JuliaHealth:mainfrom
gavinjqu:documentation-download-extract-#27
Open

Documentation/blog post: tutorial for downloading IPUMS extract #27#43
gavinjqu wants to merge 8 commits into
JuliaHealth:mainfrom
gavinjqu:documentation-download-extract-#27

Conversation

@gavinjqu
Copy link
Copy Markdown

Closes #27

This adds to docs/src/tutorials.md, which is a walkthrough of the IPUMS extract API workflow with IPUMS.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 a DataFrame via parse_ddi + load_ipums_extract. Ends with a full end-to-end script and a Limitations and roadmap section.

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), the Authorization header format, and the colmetadata key strings used in the reading section. Also, the reading section pulls in a new dependency (CodecZlib) for .dat.gz decompression, and I dropped the outer # Tutorials heading since this is the only article on the page. I'm happy to revise anything if needed.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 29.70%. Comparing base (c91f3b5) to head (18b09ec).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Successfully merging this pull request may close these issues.

[FEATURE] Create a blog post to explain how to download an IPUMS extract using the IPUMS.jl package.

1 participant