From 0270761abab223acb7dd5f770e49c531126cf040 Mon Sep 17 00:00:00 2001 From: Eirik Eylands Brandsaas Date: Wed, 3 Jun 2020 18:40:49 -0400 Subject: [PATCH] Clarified Instructions Made the instructions more foolproof --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 974e3ed..40ae4f0 100644 --- a/README.md +++ b/README.md @@ -22,17 +22,18 @@ Next, download the PSID data files yourself. The package can't automatically fet The list of data files required to be in the current directory can be found [here](https://github.com/aaowens/PSID.jl/blob/master/src/allfiles_hash.json). These files are -1. The PSID codebook in XML format. You can download this from me here https://drive.google.com/open?id=1nz1UaVGcj0ur2Bp3ev7a8agJbj0A5JTF . In the future there will be a way to download this from the PSID directly. +1. The PSID codebook in XML format. You can download this (zipped) from me here https://drive.google.com/open?id=1nz1UaVGcj0ur2Bp3ev7a8agJbj0A5JTF. In the future there will be a way to download this from the PSID directly. 2. The zipped PSID family files and cross-year individual file, which can be downloaded here https://simba.isr.umich.edu/Zips/ZipMain.aspx. Do not extract the files--leave them zipped. You need to download every family file from 1968 to 2017, and you also need to download the cross-year individual file. 3. The XLSX cross-year index for the variables, which can be downloaded here https://psidonline.isr.umich.edu/help/xyr/psid.xlsx. After acquiring the data, run ``` julia> using PSID +julia> cd("PathDataFiles\") julia> makePSID("user_input.json") # to not code missings, makePSID("user_input.json", codemissings = false) ``` -It will verify the required files exist and then construct the data. If successful, it will print `Finished constructing individual data, saved to output/allinds.csv` after about 5 minutes. +It will verify the required files exist and then construct the data. The file is stores as a .CSV file in `PathDataFiles\output\`. If successful, it will print `Finished constructing individual data, saved to output/allinds.csv` after about 5 minutes. ## The input JSON file The file passed to `makePSID` describes the variables you want. @@ -57,7 +58,7 @@ This package provides the following features: # Notable Omissions -Certain variables are not in the family files. For example, the wealth data are in separate files, and there is some unique information in the individual file directly. In the future I plan to add support for these data, but you can manually add them by constructing the unique individual ID yourself as (ER30001 * 1000) + ER30002, and then joining your data on that ID with the dataset produced by PSID.jl. +Certain variables are not in the family files. For example, the wealth data are in separate files, and there is some unique information in the individual file directly. In the future I plan to add support for these data, but you can manually add them by constructing the unique individual ID yourself as (ER30001 * 1000) + ER30002, and then joining your data on that ID with the dataset produced by PSID.jl. Please file issues if you find a bug.