Instructions for Depositing to the WEAI Data and Code Repository

Replication packages must include the following elements:

  1. A summary file (preferably in simple txt format or pdf) describing the contents of the replication package. It should explain the role and function of each file included and detail all software necessary to run the code as well as any additional add-on packages required. A simple explanation should be included providing instructions for how someone should run the code to generate the results as well as an explanation for where the results can be found once the code is finished. While not required, we suggest authors consult the README Template provided by the Social Science Data Editors for suggestions on how to write this file and assemble a data archive.
  2. All data files and code necessary to produce the main tables and figures in the manuscript should be included.
  3. Ideally authors should provide the code used to clean and organize their data from original data files. When that is not feasible, authors should provide a clear description of their process for doing so including any decision criteria for dropping or excluding data, imputing values or other data transformations performed between the original data files and the final data file. When base data files are not included, authors should explain the origin of those base data files and explain how another researcher could access them.
  4. For any projects that involve the creation of an original data set via surveys, experiments or similar methods, authors should provide full details on the methods used in that process. This involves providing data gathering instruments, experiment programs, instruction scripts and so on including a brief description for how these materials were used in gathering data.
  5. For any projects which involve simulations or computational elements, the code generating those calculations should be included as well as an explanation for how one would run the code.
  6. It is expected that some data sets may be proprietary or unable to be publicly archived. If that’s the case, this should be explained when submitting. In lieu of providing the data, authors should provide clear descriptions regarding the process to obtain the data or how other researchers might be able to obtain the data as well as clear explanations for how the data were then processed into the form used. Code for conducting the work should still be included and explained even if the data itself cannot be uploaded.

General instructions for data labeling:

  • Each variable in the data collection should have a set of exhaustive, mutually-exclusive codes.
  • Variable labels and value labels should clearly describe the information or question recorded in that variable.
  • Missing data codes should be defined.
  • Identifying information should be removed from the data to protect confidentiality.
  • Program code and command files should be annotated to facilitate replication and ensure clear correspondence between code and figures, tables, and analyses in the article.

When you are ready to upload your replication package:

  1. Select "Share Data" and sign in to the openICPSR website.
    • You will be directed to your openICPSR Workspace, where you will see a list of previously created projects and those that have been shared with you (if applicable).
  2. Click "Create New project".
    • Select “Western Economic Association International Data and Code Repository” in the “Select a repository” field.
    • Provide a descriptive project title. Title should be "Data and Code for: [Title of article]" or "Replication Data for: [Title of Article]".
    • Click "Save & Apply" to create a new project.
    • Click "View Project" to open the newly created project.
  3. Fill out study-level metadata as appropriate, including information about “Scope of Project” and “Methodology”.
    • Complete the list of principal investigators (authors). Please ensure that all authors have affiliations (if not affiliated: “Independent Researcher”).
    • Add a descriptive summary of your project. This can be a copy of the abstract from your article, a note that this is data and/or code accompanying the article, and/or text that clearly allows people to understand the purpose of these materials independently.
    • Select subject terms (e.g., “Machine Learning” or “Randomized Control Trial”).
    • Select JEL classification(s) (should be the same as article).
    • Fill in the manuscript number (your Scholar One tracking number as assigned by the editorial office); this will allow us to properly connect the repository with the manuscript.
  4. Upload data, computer programs, sets of computer program codes, extracts of existing data files, and supporting documentation necessary to replicate the results of your analyses without any additional information from the author(s).
    • Choose "Upload Files" to add multiple files; choose "Import from ZIP" to upload a ZIP file. WEAI requires that you import zip files instead of uploading as-is.
      1. Please upload the README (in PDF or TXT format) as the very first file ensuring that it can be found easily by those browsing the archive.
      2. If the uncompressed contents of the deposit (the unzipped size of the zip file) are larger than 30GB, or if you have more than 1,000 files in your deposit, please email icpsr-help@umich.edu with your project number, expected size, and/or number of files to identify an upload solution for your project.
      3. After clicking the appropriate button, drag and drop your files or choose files through a file selection window.
      4. Click "Upload" to transfer files into your openICPSR project workspace.
    • Close the upload window after the files are uploaded successfully.
    • You should see a list of files and directories in your openICPSR project workspace. The ideal structure includes:
      1. No redundant directories: the first items you should see are the README and any subdirectories.
      2. There should be no zip files!
      3. The structure should be as you last ran the code. What you see in the deposit interface is what others will see once it is published.
  5. Under the "Related Publications" section, add a new entry by clicking "Add value".
    • Select "Is supplemented by" as type.
    • Select "Manually Enter Citation", and then select "Journal Article" as the publication type.
    • Fill in the title and authors of the submitted article or manuscript (which may differ from the name of the uploaded dataset).
    • Enter the name of the WEAI journal to which you submitted.
  6. Once you have completed all of the above, click "Publish Project".
    • On the Publish data page, you can review the files you have uploaded. If everything is correct, click "Proceed to Publish".
    • A terms and conditions page is presented. Follow the remaining instructions by answering questions about disclosure risk, answering "No" to the delayed dissemination question unless previous arrangements have been made with the relevant WEAI journal editor, and agreeing to the terms of the openICPSR Deposit Agreement to complete the publishing process.
  7. When your project has been published, you will receive a data citation and DOI (persistent URL). Add the data citation provided by openICPSR to the references of your final paper before uploading it for production in ScholarOne.
  8. When your article has been published online, WEAI will ask you to add the assigned Wiley DOI in the "Related Publications" section of your openICPSR project.