Git Product home page Git Product logo

ipums-pma-longitudinal-guide's Introduction

IPUMS-PMA-Longitudinal-Guide

This repository includes code featered in the IPUMS PMA Longitudinal Analysis Guides for both R and Stata users.

You can download PDF versions of each guide below:

ipums-pma-longitudinal-guide's People

Contributors

matt-gunther avatar

Stargazers

 avatar

Watchers

 avatar  avatar

ipums-pma-longitudinal-guide's Issues

Chapters 4 & 5

Should we reorganize Ch4 to only include the calculation of indicators, but save the graphics for Chapter 5? This would isolate some differences between Stata & R.

Figures

Because many figures need to be rotated for full page display, let's save all figures as pngs and read with knitr::include_graphics.

References to "missing" values in Stata version

We should be careful not to say "missing" when describing the value . in Stata. The term "missing" is already used in a value label for survey responses that are not NIU, but are otherwise "missing".

In R, these values appear as NA. In Stata, is it appropriate to say "blank"?

Preface Page Numbering

Currently, roman numerals begin on the cover page. It would be better if the began with the TOC.

Chapter Setup

Every chapter should have a list of included:

  • samples
  • cases
  • variables
  • R packages

DOI

Can IPUMS issue a DOI?

Revision History

Major revisions should be noted inline in the guide (e.g. when Phase 3 data are released by IPUMS PMA).

Minor revisions (e.g. typos) can probably just be noted in a commit message.

Relative Links

Makes sure that all relative URLs (e.g. ../2022-03-01-phase2-discovery/#sampling) are removed or replaced with absolute URLs.

Variable names

In-line variables names currently link to the IPUMS PMA documentation only on first-mention, then they switch to code.

Separately, IPUMS Stata variables are always lower-case, while IPUMS R variables are always upper-case.

I've written an R function that will automatically build the URL for a provided variable (corrected by stripping any numeric suffix), and show it in lower case. To implement: find and replace bare variable names with the function call.

Comments in code chunks

Let's promote as many of these as possible to an aside - this is particularly important with the Stata version, where words that are also function-names are colorized incorrectly (seems like a real pain to deal with this otherwise, and the colorization is a nice feature otherwise)

Code Chunk Styles

I'm using 20% "PMA Pink" (#98579B20) for chunk output background, but no color for chunk input. This is because asides sometimes align with chunk input (if explaining code) and we don't want them to overlap.

Hope this is ok? Could also consider a v-bar on the left (we do this on the blog after all).

Appendixes

Dale suggested a few that looks helpful - should they go at the front or the back?

  • Availability of data from pmadata.org
  • Suggested citation
  • Acknowledgements
  • Abbreviations
  • Glossary of Terms

Citations

The citation function we use for References on the blog isn't implemented by Pagedown. Look into a solution for this (should be NBD: there are only 3-5 citations throughout)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.