crosswalk README file within product?

[jGaboardi]

The questions was raised about whether to include a README.txt within a zipped archive for all crosswalk products. This is currently done with the original nhgis_blkYEAR-blkYEAR_g{e}{j} data available here.

[jGaboardi]

Options for storage/saving

• compressed nhgis_blkYEAR-blkYEAR_g{e}{j}.csv and standard README.txt in a directory then zip the directory
• standard nhgis_blkYEAR-blkYEAR_g{e}{j}.csv and standard README.txt in a directory then zip the directory
• other?

[jGaboardi]

Proposed workflow/content:

• README.txt files stored in /resources/readme_files/
  • one for each source-target combination (same file for each state subset)
• add upper-level function for generating data based on the /notebooks/generate-nation-and-states-*ipynb notebooks
  • include functionality to:
    • fetch the proper README.txt
    • create directory named {crosswalk} with {crosswalk}.csv and README.txt
    • zip the directory
• revisit .csv - .csv.zip - .zip in xwalk_df_to_csv and xwalk_df_from_csv

[jGaboardi]

product progress

• nhgis_blk1990_blk2010_gj
  • nation
  • state-level
• nhgis_blk1990_blk2010_ge
  • nation
  • state-level
• nhgis_blk2000_blk2010_gj
  • nation
  • state-level
• nhgis_blk2000_blk2010_ge
  • nation
  • state-level
• nhgis_bgp1990_bg2010
  • nation
  • state-level
• nhgis_bgp1990_tr2010
  • nation
  • state-level
• nhgis_bgp1990_co2010
  • nation
  • state-level
• nhgis_bgp2000_bg2010
  • nation
  • state-level
• nhgis_bgp2000_tr2010
  • nation
  • state-level
• nhgis_bgp2000_co2010
  • nation
  • state-level
• decision add archives to ./testing_data/ ?
  • nhgis_blk1990_blk2010_gj.csv — this is currently nhgis_blk1990_blk2010_gj.zip
  • nhgis_blk1990_blk2010_gj.zip — this should be the zipped archive
  • nhgis_blk2000_blk2010_gj.csv — this is currently nhgis_blk1990_blk2010_gj.zip
  • nhgis_blk2000_blk2010_gj.zip — this should be the zipped archive
• decision regarding original crosswalks vs. archives...
  • add archives to ../../crosswalks/?

[jGaboardi]

retry with preprocessing step:

• use shutil to zip up the original block stuff prior to running the blk-blk creation notebook.

[jGaboardi]

Partially resolved via #72 --> continuing in #80.