J-PAL promotes the publication of de-identified data from randomized evaluations. This resource provides guidance on doing so in the form of a checklist for preparing data for submission. It also includes sample informed consent language and other considerations during project planning and before publication, and provides a description of trusted digital repositories that can host data. This guide is intended to be read alongside the accompanying data de-identification resource.
Data publication overview
Over the last decade, the number of funders, journals, and research organizations that have adopted data-sharing policies has increased considerably. When the American Economic Association adopted its first policy in 2005, it was among the first academic journals in the social sciences to require the publication of data alongside the research paper. Today, data publication is required by most top academic journals in economics and the social sciences. Similarly, foundations and government institutions, such as the Bill and Melinda Gates Foundation, the National Science Foundation, and the National Institutes of Health, have data publication policies. J-PAL, as both a funder and an organization that conducts research, adopted a data publication policy in 2015 that applies to all research projects that we fund or implement.
This guide and the accompanying guide on de-identification are intended to help research teams think about the steps involved in publishing research data. They draw on J-PAL’s experience of publishing research data on randomized evaluations in the social sciences for more than a decade.
Why publish research data
Increasing the availability of research data benefits researchers, policy partners who supported the studies, students who learn from using the data, and, importantly, the people from whom the data was collected. Data sharing can provide many benefits and opportunities to the research community, including:
- Allowing for re-use of the data by researchers, policymakers, students, and teachers around the world
- Creating insights based on multiple studies through meta-analyses, and answering questions on external validity and generalizability of results.1
- Enabling the replication and confirmation of published results as well as sensitivity or complementary analyses.
We are still in the early stages of data availability in social science research. Gertler, Galiani, and Romero (2018) found that only a small minority of empirical papers published in the top nine journals in economics in May 2016 contained all the necessary materials (raw data, estimation data, cleaning code, and analysis/estimation code) to successfully reproduce the results of the original study. J-PAL’s goal is to make research data from randomized evaluations widely available and accessible.
Considerations before publishing
Before publishing your data, you should ensure that you have the legal, regulatory, and ethical authority to do so. Some questions to ask at the outset of the data publication process include:
- Who is the owner of the data? Was it collected by the research team through surveys, or is the data part of an administrative dataset that was provided by a third party? See below for additional considerations when publishing administrative data.
- What did you report to your institutional review board (IRB) at the outset of the study? How did you describe what would be done with the data? Did you mention data-sharing in your original protocol? Does your IRB have any specific guidelines on how research data should be published?
- What information was provided to the study participants about how their data would be used? See below for sample consent form language that allows for data publication.
- How sensitive is the data that was collected? Does the data include private health information and biomarkers, information about criminal activity, personal financial information, or agricultural yields?
- What kind of data do you plan to publish (demographic information, geographic information)? How identifiable are the study participants based on the data you plan to publish? Will all identifiers be removed, redacted, or masked during the publishing process? If not, have you considered publishing in a restricted data archive? See the accompanying de-identification resource for more information.
- What jurisdiction(s) or legal authorities govern the data you collected? Does the jurisdiction have certain legal frameworks you need to consider?
- Does the donor have specific requirements for publishing research data? What are their requirements? Is there a particular timeline by when you must publish the data? Is there certain data that must be published? Is there a particular location where the data should be published?
Addressing these questions will help determine where and what data to publish.
Permission to publish
Informed consent for survey data
All studies that collect survey data from individual subjects should go through an informed consent procedure; see more in the IRB resource and Define intake and consent process. The informed consent procedure should include language that allows for the publication of de-identified data. As with all parts of the consent procedure, this language should be concise and clear while avoiding jargon or technical terms that study participants may not understand. Before collecting data, researchers should review their consent process regarding data sharing.
- Avoid using complicated or confusing terms such as “confidentiality” or “de-identification.”
- Avoid making promises that might limit what data can be shared later, such as “only members of the research team will have access to the information or responses that you provide to us.”
- Avoid using terms that might not be achievable, such as “anonymous” or “anonymity,” as truly anonymous data is a very high bar.
Sample consent form language that could be used (subject to approval by the IRB of record):
EXAMPLE CONSENT FORM LANGUAGE THAT PERMITS SUBSEQUENT DATA PUBLICATION
No one outside the survey team can directly connect your personal details, like your name, address, and cell phone number, with anything you say in this survey. Your survey responses and personal details will be stored in secure international computer storage. Your personal details will be encrypted and password-protected to prevent unauthorized access. Before we share the study with anyone other than the research team, your personal details will be separated from your survey responses. We do this to prevent anyone outside the research team from linking your survey responses back to you.
The Inter-university Consortium for Political and Social Research (ICPSR) has developed a set of recommendations for researchers to think about when drafting informed consent clauses. Remember that informed consent and data-sharing disclosure requirements may vary by host institution and legal jurisdiction in which the data is collected; if in doubt, consult with the IRB of record.
Data use agreements for administrative data
In addition to the considerations listed above, publishing and sharing administrative data requires permission from the data provider, who will have final determination over what data can be published. Data that is provided by a third party often falls under additional regulatory authorities.
Much of what a research team can do with administrative data is controlled by the data use agreement (DUA) signed with the data provider at the beginning of the study. It is thus important to have a conversation about data-sharing with the data provider at the beginning of the study so that plans for publishing data can be added to the DUA at the outset. If the DUA does not clearly regulate data publication, then it is critical to consult with the data provider, and any research partners or implementing organizations, to determine what data can be published.
Data providers might have concerns about sharing their data because it is often governed by robust regulatory regimes (such as private health information, personal financial information, or criminal activity). They may be concerned about the privacy of participants or other potential effects if certain information is released. For example, businesses may be concerned about competitors using the data to gain commercial advantage, while government agencies may be concerned about political sensitivities, such as the release of data on spending practices or total case numbers.
It is important to discuss with data providers that data can be made available in a variety of formats. Restricted data archives, discussed in further detail below, provide locations where more sensitive and regulated data could be made available.
If a data provider has agreed to make data from the study publicly available, additional considerations include:
- Is there a review period for data providers? Many DUAs stipulate that data providers must have a chance (often 30 days) to review any papers, presentations, or use of their name prior to publication or submission for publication.
- Do the DUA and IRB allow researchers to publish data alongside the paper? If so, are there any conditions?
- Does the DUA or IRB specify that data must be deleted or returned to the provider?
Where to publish
Trusted digital repositories
Published research data should be stored in a trusted digital repository to ensure long-term access to the files and documentation. A trusted digital repository is defined as a data repository “whose mission is to provide reliable, long-term access to managed digital resources to its designated community, now and in the future” (RLG 2002).
A trusted digital repository is committed to maintaining the repository in perpetuity, ensures minimal to zero data loss or data rot, and allows for version control. For example, the Harvard Dataverse allows users to view exactly what has changed, starting from the originally published version to any subsequent published versions. Users are also allowed to access these versions and see the changes made for that particular dataset. A trusted repository also assigns each dataset and its associated program code with a unique identifier (e.g., a “digital object identifier” (DOI)) to enable citation, cataloging, and search. This identifier is designed to persist even if URLs––or the website itself––change. Most digital repositories capture metadata about the published research materials. This allows future researchers to quickly explore and understand the data without having to download the data and run the code.
Some common trusted digital repositories used by researchers in the social sciences include:
- Harvard Institute for Quantitative Social Sciences (IQSS) Dataverse
- Mendeley (by Elsevier)
- The UK Data Archive
- Yale Institution for Social and Policy Studies (ISPS) Data Archive
While posting data on personal websites (even if hosted by the university) technically makes it public, the lifespan of personal websites is much shorter than that of a trusted digital repository. Furthermore, it makes the data more difficult to search, cite, and explore. Instead, researchers can cite their published data on their personal websites by using the permanent identifier (DOI) to link to where the data is stored.
Restricted data archives
Some repositories have set up archives for particularly sensitive data. In addition to open ICPSR, a free public access repository, the ICPSR has also developed more secure repository options that range from secure downloads to physical on-site storage. More information on ICPSR’s restricted repositories can be found on their website.
A checklist for data publication
This section provides a checklist of steps and best practices for researchers who wish to publish their research data. The checklist draws from the World Bank’s Microdata Catalog submission checklist, and further information can also be found in ICPSR’s Guide to Social Science Data Preparation and Archiving.
Preparing data for submission
After ensuring you have the authority to publish your data, you can prepare the data for publication. The process has two purposes: first, to ensure the dataset is clean and comprehensible to new users, and second, to make sure that the privacy of research subjects is protected.
The best way to publish a set of files related to a research project is to save them in a clear file and folder structure and then compress the entire set of folders into e.g., a zip archive. The folder structure might look something like the following:
- Main folder
- Additional documentation
Steps to prepare each of these files are described next. Recognizing that preparing data for publication can be a time-consuming and involved process, we differentiate between steps that are absolutely essential, important (steps that we strongly recommend, as they facilitate re-use of the data), and suggested (additional steps that facilitate data re-use further but are less essential)
- Essential: Provide the data in a file format that can be used independently of statistical package choice, such as csv files.
- Essential: Ensure that your data is de-identified.
- Essential: Include all variables, treatment conditions, and observations collected from the implemented survey instruments (excluding PII)––if feasible and allowed by the data provider (for administrative data).
- Important: Keep enumerator IDs (so that enumerator effects can be controlled for in analysis). These IDs should be randomly generated so that enumerators’ identities cannot be linked.
- Suggested: Keep the interview date (the day, week, or month of interview may be important for certain analyses, such as if asking respondents about consumption over the past seven days).
- Less important to include are variables used for quality control during data collection. If using SurveyCTO, this could include text audits and time stamps (start time and end time). Automatically collected information such as the device ID, the subscriber ID, the
SIM ID, and the device phone number do not need to be included––not least, they could contain identifying information.
- Suggested: Keep “raw” variables along with constructed, corrected, or imputed variables (except in cases where the raw variables could be used to identify individuals, as could be the case for variables with outliers).
- If you have multiple datasets (e.g., administrative data on all households but survey data for only the households you interviewed, or a field-level dataset and a household-level dataset), then do the following:
- Essential: Ensure there are ID variables in each dataset that link across datasets (e.g., ensure the household ID is in both the household-level dataset and the field-level dataset).
Important: Ensure there is no overlap between datasets (e.g., if you have panel data on daily electricity consumption and a survey that was conducted only once, do not publish a merged dataset (that includes the daily electricity consumption merged with the survey data) AND the two datasets separately––either publish just the merged file OR publish the two separate datasets. If one data set is much larger than the other, then they are ideally separate. This reduces the risk of inconsistencies and saves computer storage and memory when working with the data.
Additional checks for data:
- Essential: Does the ID variable uniquely identify observations?
- Essential: Are all missing values correctly and consistently coded and labeled?
- Essential: Can variables be matched with the accompanying questionnaire?
- Important: Is the ID the first variable listed?
- Important: Are all variables labeled? This can be done automatically by many digital data collection platforms, such as SurveyCTO.
- Important: Do all categorical variables have value labels? This can also be done automatically in SurveyCTO and similar software.
- Important: Other than the ID variable, are the variables ordered in a logical way? For example, if the order of the survey questions is potentially relevant for understanding the data, then the variables should be ordered in the same way. Distinct survey modules are often best grouped together. Variables in panel data (e.g., baseline and endline) should be grouped together and included in the same order for each wave (ideally, the variable names are the same for each wave, with suffixes indicating the survey wave).
- Essential: Include programs and scripts needed for a push-button replication of all published results:
- Make sure code files have headers (including the name of the person who last wrote/edited the code, the date, and the software and version used).
- Make sure code has comments or is self-documenting.
- Remove unnecessary code that creates tables and figures that are not included in the main results or appendix of the paper.
- Remove comments that are not necessary, such as comments and messages between the research team.
- Important: Data cleaning and variable construction documentation
- Codes for missing values in survey instrument and dataset.
- We suggest using Stata’s extended missing values (for example, don’t know = .a, refuse to answer = .b, etc.). While researchers sometimes use values that will stand out when looking at the distribution of a variable, such as missing = –999, refused to answer = –888, Stata’s extended missing values are preferred because they will be dropped automatically, without the need for a careful eye to look at the distribution of every single variable.
- Record of corrections made
- Were any variables grouped, top- or bottom-coded, smoothed out, or imputed? What method was used?
- If variables are masked for de-identification, report method used (link below).
- If applicable, describe how to link observations across data files (e.g., in an agricultural survey, describing how demographics of a plot manager who is a family member could be obtained by linking the plot roster to the household roster using household IDs, plot manager IDs, and family member IDs).
- If variables (e.g., consumption, total income) were constructed, how?
- Codes for missing values in survey instrument and dataset.
If including output files with your published data, we suggest self-explanatory naming of files (e.g., table 1, table 2, etc.; or main tables, robustness checks, appendix tables, etc.), matching the corresponding publication.
- Essential: At a minimum, include the PDF version of the questionnaire in English translation, though we recommend also including the questionnaire in the original language if not in English.
- Suggested: Including a pre-programmed SurveyCTO form can assist researchers wishing to conduct a statistical replication of the study in other settings.
- Essential: Ensure PII (village names, etc.) is removed from all published questionnaires and documentation.
- Essential: At a minimum, include the PDF version of the questionnaire in English translation, though we recommend also including the questionnaire in the original language if not in English.
- Important: Provide research materials and description of procedures necessary to conduct an independent statistical replication of the research, including the following:
- Dates of fieldwork
- Number of households visited
- Refusal rates
- Number of households and individuals in the final sample
- Problems that occurred during the administration of the survey
- Enumerator manuals, preferably in English translation
- Important: Provide a copy of, or link to, the manuscript (published or working paper) that was written based on the specific data and code, if applicable.
A readme file is essential. The readme file should be in an open, platform-independent format such as ASCII text, markdown, or a PDF and at a minimum include the following:
- Description of data (e.g., replication data for xyz paper)
- Date of data collection
- System requirements
- How to run the code files
- List of files with short description
- Permissions for publishing the data—this ideally includes the IRB approval number and institution, with a reference to or quote of the section of the section that allows publication of the de-identified data. If applicable, it should also include information on the data use agreement (DUA) and quote of the clause in which the data provider approves data publication.
- Additional notes: for example, you may describe re-use rights, provide a recommended citation format or repository where the latest version of the data is stored, list contact information, etc.
For an example of a published readme document, see Vilhuber et al. (2020).
Submitting data to a repository
- Suggested: Execute final versions of the code. Once all the code has been edited to accommodate the changes in the data, run it to ensure it runs without error and that the new results are consistent with those reported in the accompanying published or working paper.
- Suggested: Maintain file structure for data users. First check the repository’s policy and process guidelines for uploading. Each repository has a different process. We recommend zipping all of the files you have prepared in one folder so that the all files will be downloaded together in the appropriate structure. (NOTE: Dataverse unzips archive files when data is uploaded, but stores the folder structure for cases when the package is downloaded as a whole.)
- Important: When submitting a dataset, the inclusion of detailed metadata can facilitate re-use by providing other researchers with key information about the data without needing to download it. Whenever possible, metadata should be added to the fields in the repository, making it machine readable. However, if no fields are provided by the repository and no additional fields can be added to the repository, then you should include metadata in the readme documentation. We strongly recommend including the following:
- Study identification: Project title; names of all principal investigators (if available including research ORCID numbers); keywords; and conflict of interest or funder information
- Study overview: Target population, intervention type, methodology, whether this is a panel study, anticipated survey rounds (if panel study, then list number of surveys in this round), project description, project period, related publication or working paper
- Geospatial metadata: Country, state, district, and other relevant toponyms; geographical coverage (e.g., national, state, school)
- Implementation: Unit of randomization, if applicable (if clustered, specify level of clustering); unit of stratification, if applicable; unit of analysis (individuals, households, firms, schools, etc.); variables describing units of randomization, stratification, and analysis; sampling method for study inclusion; sampling method for each survey round; and project partners and nature of partnership (e.g., schools provided venue to meet with parents, hospitals gave records of doctor visits)
- Software/programs: Software of code and program version number
- Note: Different data repositories have different limits regarding file size. The repositories listed above (ICPSR, Dataverse, and the ISPS Data Archive) generally do not limit the number of files that can be uploaded but may limit file size (e.g., the Harvard Dataverse limits file size to 2.5 GB). Support for big data publication and use is under development at some repositories (see the Dataverse’s most recent work to this end). If your file size exceeds the limit for your chosen repository, we recommend compressing the file to below the size limit (if possible). You may be required to split the large data file into two or more files by only including a subset of the variables in each file. Consider creating randomized extracts so that interested users can open one of the files and see a representative subsample. You may contact the repository support team for advice on how to handle large datasets.
Updating published data
Trusted data repositories allow for version control, which is especially useful for long-term research data management where metadata and files are updated over time. Versioning is used to track any metadata or file changes (e.g., by uploading a new file, changing file metadata, adding or editing metadata) once you have published your dataset. In most repositories, a new DOI will be issued for each version. When updating versions of published data, it is important to include a note documenting the changes made from the previous version.
A trusted repository will automatically document changes such as metadata changes and addition/deletion of files, but it will not document the specific changes inside the files. So for these data/file-specific changes, it is useful to note down in the readme file the changes that were made. For example:
- Version 1: Nairobi eye clinic survey round 1
- Version 1.1: Coding error fixed
- Version 1.2: Added related publication
- Version 2.0: Round 2 data added
The act of removing a dataset from a digital repository where it has been published is known as deaccessioning. Most repositories will have a process for deaccessioning a dataset. Deaccessioning is an important component of version control that allows the metadata and citation of the data to remain available even if access to the data is removed. You can deaccession one version of a dataset or the entire dataset. Deaccessioning of a dataset could happen for a variety of reasons. For instance, if a research team inadvertently publishes the wrong dataset, incomplete data, or code with an error, then they might want to deaccession the dataset and upload the correct dataset that accompanies their study. When a dataset is deaccessioned, that version will no longer be available, but the citation and metadata will remain available. This allows other researchers to know that a version of the dataset existed previously in case they come across it in another study.
Last updated July 2020.
These resources are a collaborative effort. If you notice a bug or have a suggestion for additional content, please fill out this form.
Berkeley Initiative for Transparency in the Social Sciences, Replication
Center for Open Science, Transparency and Openness Promotion Guidelines
Dataverse, Big Data Support
World Bank, Checklist: Microdata Catalog Submission
Bandiera, Oriana, Fischer, Greg, Prat, Andrea, and Erina Ytsma. 2016. “Do Women Respond Less to Performance Pay? Building Evidence from Multiple Experiments.” CEPR Discussion Paper No. 11724. [Gated version]
Dillon, Moira R., Kannan, Harini, Dean, Joshua T., Spelke, Elizabeth S., and Esther Duflo. 2017. "Cognitive Science in the Field: A Preschool Intervention Durably Improves Non-Symbolic, but not Symbolic, Mathematics." Harvard Dataverse, V2. doi:10.7910/DVN/LCLKDT
Gertler, Paul, Galiani, Sebastian, and Mauricio Romero. 2018. “How to Make Replication the Norm.” Nature 554, 417–419. doi: 10.1038/d41586-018-02108-9
Meager, Rachael. 2019. “Understanding the Average Impact of Microcredit Expansions: A Bayesian Hierarchical Analysis of Seven Randomized Experiments.” AEJ: Applied 11, 57–91. DOI: 10.1257/app.20170299
Research Libraries Group. 2002. "Trusted Digital Repositories: Attributes and Responsibilities." An RLG-OCLC Report. https://www.oclc.org/content/dam/research/activities/trustedrep/repositories.pdf
Vilhuber, Lars, Koren, Miklos, Llull, Joan, Connolly, Marie, and Peter Morrow. 2020. "A Template README for Social Science Replication Packages." Social Science Data Editors. https://social-science-data-editors.github.io/template_README/