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

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

Open
7 tasks
00krishna opened this issue May 20, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@00krishna
Copy link
Collaborator

Issue Description

This is a more technical blog post that shows a user how to setup and download an IPUMS extract using the IPUMS.jl package. Users can download IPUMS extracts in two ways, either through the IPUMS website or through the package IPUMS.jl. This blog post should introduce the user to using the download API in the package to create and download an extract file.

Another way of phrasing this task is to recreate the ipumsr R package post, but with a focus on the Julia IPUMS.jl package.

Difficulty: Beginner

Time: 6 - 8 hours

Requirements

  • Explain the 2 ways to download IPUMS extract files.
  • Explain about getting an API key for authentication for downloads.
  • Show how to user would select the variables for their specific inquiry.
  • Show how the user would select weights and quality scores for their variables of interest.
  • Show how the user would setup and execute a download for files from the IPUMS USA or IPUMS CPS projects.
  • Show how the user would setup and execute a download for files from the IPUMS NHGIS project.
  • submit PR for this blog post.

Expected Outcomes

A blog post written in Markdown that explains to a user how to download IPUMS files using the IPUMS.jl package.

Additional Notes

The R ipumsr package has a good explanation of downloading an extract from the IPUMS website.

Other Resources

Julia Slack:

  • documentation channel - you should post here first
  • helpdesk channel - this would be to get more attention to your issue but maybe not as precise as you need.
  • health-and-medicine channel - this is where most of JuliaHealth is located these days.

Julia Discourse - I would advise posting here if you have an issue that you feel is long or requires a lot of time to explain as you might lose it within Julia Slack. Consider cross-posting your forum post to the Julia Slack in helpdesk and/or documentation.

@00krishna 00krishna added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels May 20, 2024
@TheCedarPrince
Copy link
Member

This looks like a good write-up @00krishna. I actually think this might be better to put into the documentation of the package versus a separate blog post on the JuliaHealth website. What's your opinion Krishna?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants