Depositing in the WEAI Data and Code Repository
Replication Package Requirements
Replication packages must include all materials needed to reproduce the main tables and figures in the manuscript.
1. README File
Include a README file, preferably in TXT or PDF format, as the first file in the archive. The README must follow the Social Science Data Editors README Template and should include:
- A summary of the replication package contents
- The purpose of each file
- Software requirements, including versions and required add-on packages
- Clear instructions for running the code
- An explanation of where generated results will appear
- Notes explaining any missing materials or limitations
2. Data and Code
Include all data files and code needed to reproduce the manuscript’s main analyses, tables, and figures. When possible, provide code that cleans and organizes the data from the original source files. If this is not possible, explain:
- How the data were cleaned and processed
- Any criteria for excluding observations
- Any imputation or transformation procedures
- The origin of any base data files
- How other researchers can access those base data files
3. Original Data Collection Materials
For projects involving original data collection, such as surveys, experiments, or similar methods, include relevant documentation, such as:
- Survey instruments
- Experimental programs
- Instruction scripts
- A brief explanation of how these materials were used
4. Simulations or Computational Work
For projects involving simulations or computational analysis, include:
- The code used to generate the results
- Instructions for running the code
5. Proprietary or Restricted Data
If data cannot be publicly archived, explain this in the README. Authors should still provide:
- A clear description of how the data can be obtained, if possible
- An explanation of how the data were processed
- All code necessary to conduct the analysis, even if the data cannot be uploaded
Data Labeling and Documentation
Data files should be clearly labeled and documented. Please ensure that:
- Each variable has exhaustive and mutually exclusive codes
- Variable labels and value labels clearly describe the information recorded
- Missing data codes are defined
- Identifying information has been removed to protect confidentiality
- Program code and command files are annotated clearly
- Code corresponds clearly to the manuscript’s tables, figures, and analyses
Before Uploading
Before starting your deposit, review the replication package checklist used by the Data Team. Make sure a reviewer would be able to answer “Yes” to all relevant checklist items. If any requirement cannot be met, explain the reason in the README.
Starting Your Deposit
- Select “Start your deposit” and sign in to the ICPSR website.
- In your ICPSR Workspace, select “Create New Study” and then “Proceed.”
- Enter a descriptive project title using this format:
[ECIN or COEP] Replication Package for [Title of Article]
Study Metadata
Complete the study-level metadata, including:
- Principal investigators/authors, with affiliations for all authors.
- If an author has no affiliation, use “Independent Researcher.”
- A descriptive project summary. This may be the article abstract or a brief description of the accompanying data and code.
- ICPSR subject terms, such as “Machine Learning” or “Randomized Control Trial.”
- JEL classifications matching the article.
- Time period covered by the data.
- Geographic coverage.
- Manuscript number, using the ScholarOne tracking number assigned by the editorial office.
- Universe and data type, as relevant.
- If only code is deposited, select data type = program source code.
- Methods information, especially for survey or experimental data, such as response rates and sampling procedures.
After completing the Describe Data page, click “Save & Continue.”
Uploading Files
Upload all data, code, extracts of existing data files, and supporting documentation needed to replicate the results without additional information from the authors.
File Upload Instructions
- Upload the README first, preferably in TXT or PDF format.
- Use “Upload” to add files, folders, or Zip archives.
- WEAI requires that Zip files be imported rather than uploaded as-is.
- After import, the deposit should not contain Zip files.
- Do not leave the page while files are uploading.
If the uncompressed deposit is larger than 30GB, or if it contains more than 10,000 files, email [email protected] with your project number to identify an upload solution.
Recommended File Structure
The project workspace should be easy to browse. Ideally:
- The first visible file should be the README
- Subdirectories should be clearly named
- There should be no redundant folder layers
- There should be no Zip files remaining after import
- The structure should match the version used to run the code
What appears in the deposit interface is what others will see once the archive is published.
After completing the Deposit Data page, click “Save & Continue.”
Deposit Settings
On the Deposit Settings page:
- For ICPSR Archive Collection, select “WEAI Repository.”
- Select “No” for Study Curation Request.
- Select “No” for the disclosure risk questions.
- Enter the manuscript number.
- Enter the name of the WEAI journal to which the manuscript was submitted.
- Click “Save & Continue.”
Deposit Agreement
On the Deposit Agreement page:
- Select the radio button for deposit approval.
- Click “View & Sign Deposit Agreement.”
- Type your name to electronically agree to the deposit terms.
- Answer the ADA Accessibility question.
- Select a license for the data collection.
- Click “Submit for Review.”
Journal staff will contact you after reviewing the submission. Revisions may be requested.
Before uploading the final paper for production, add the ICPSR data citation to the references section and include a Data Availability Statement using one of the journal’s standard templates.