Task Index
This list is meant to give you an overview of the parts of Peekbank you can contribute to, and what prerequisites (accounts, permissions on resources, etc.) are needed.
Analyse Peekbank data
Section titled “Analyse Peekbank data”You need
- a free Redivis account
The released data is public, so just use our provided interfaces to pull it and refer to the Data Schema and Codebook for the details on the data structure. If you opt for PeekbankR, we provide helper functions to facilitate analyses involving CDI data or stimulus images.
Share your own study data
Section titled “Share your own study data”If you have collected looking-while-listening data and want it in Peekbank, great! We will take care of most of the import work; refer to the page on Sharing Data for details.
Add raw data to be imported
Section titled “Add raw data to be imported”You need
- a Redivis account
- edit access to peekbank_files on Redivis
- edit access to the Peekbank datasets sheet on Google Sheets
- (optional) for datasets with private raw data, edit access to peekbank_private_raw on Redivis
To add a dataset we have received to Peekbank’s raw data:
- Pick an identifying internal name for it (see the list of current datasets for examples).
- Add the dataset to the Peekbank datasets sheet.
- Open the draft version of peekbank_files on Redivis.
- Click
+ Upload files(clickingCreateif asked to create a new version), chooseUpload directoryand select the local folder containing the raw data. - In the
Destination folderdropdown, scroll down and click+ Create new folder. - Enter the internal name from step 1 under
New folder nameand clickUpload. Files in nested folders keep their parent folders as a prefix.
Making newly added raw data available to importers outside the Peekbank team
The added files now live in the draft "next" version. By default, only people with edit privileges on datapages.peekbank_files can read this version; everyone else gets the latest published version. If you want people without this privilege to write import scripts (e.g. in a Peekbank hackathon), use the Review and release button to create a versioned release.
If you want to add or replace files, use the + Upload files button and choose the folder of the dataset you want to edit.
If you want to delete files, click on the dataset’s folder name in the right panel and delete the file.
What about datasets that do not allow us to share the raw data?
Raw data that may not be shared publicly (e.g. the NIH Baby Toolbox dataset) goes into peekbank_private_raw, which only the Peekbank team can see. To upload such a dataset in a way that the pipeline can pick up:
- Pick an identifying internal name for it (see the list of current datasets for examples).
- Add the dataset to the Peekbank datasets sheet.
- Open the draft version of peekbank_private_raw (this is the private one) on Redivis.
- Click
+ Upload files(clickingCreateif asked to create a new version), chooseUpload directoryand select the local folder containing the raw data. - In the
Destination folderdropdown, scroll down and click+ Create new folder. - Enter the internal name from step 1 under
New folder nameand clickUpload. Files in nested folders keep their parent folders as a prefix. - On your computer, create an empty file named
raw_data_in_private_repo.txt. - Open the draft version of peekbank_files (this is the public one) on Redivis.
- Click
+ Upload files, chooseUpload filesand select the file from step 7. - In the
Destination folderdropdown, scroll down and click+ Create new folder. - Enter the same internal name from step 1 under
New folder nameand clickUpload. This placeholder tells the import scripts to look for the raw data in peekbank_private_raw.
The import scripts then automatically download the raw data from peekbank_private_raw for everyone who has access to it. The processed data still goes to the public peekbank_files, as that data has the same shape as what will be distributed via the Peekbank releases.
Transform data into the Peekbank schema
Section titled “Transform data into the Peekbank schema”You need
- a Redivis account
- a GitHub account
- either write access to peekbank-data-import (ask the Peekbank team) or your own fork to open pull requests from
- (optional) to upload the result, edit access to peekbank_files
- (optional) for datasets with private raw data, read access to peekbank_private_raw
To turn a raw dataset into Peekbank-ready tables (“data import”):
- Clone peekbank-data-import.
- Pick a dataset from the Peekbank datasets sheet that hasn’t been imported yet.
- Set up an import script for it as described in the repository’s README.
- Fill in the code following the steps in the documentation, and note any relevant import decisions in the dataset’s README.
- Run the script. It validates the data and prints a summary with plots to check against the original paper.
- Once the data looks right, set
upload=TRUEinwrite_and_validate_list()and run it again to upload the processed data to Redivis. - Ask someone on the team to review the import. Once they are happy with it, they delete
ignored_by_pipeline_remove_after_review.txtfrom the dataset folder and commit the deletion along with any fixes, which adds the dataset to the next release.
Release a new Peekbank version
Section titled “Release a new Peekbank version”You need
- a Redivis account
- edit access to Peekbank on Redivis
- edit access to peekbank_files on Redivis, as the release uploads the processed data that changed
- read access to peekbank_private_raw on Redivis, as a release reruns every import (including those with private raw data)
To build and publish a release:
- Clone peekbank-data-import and set it up as described in its ingestion README.
- Commit hashes of that repository get baked into releases. If you have any local changes, commit them, get them onto master on GitHub and/or pull the latest master. Only the folders of datasets that still hold an
ignored_by_pipeline_remove_after_review.txtmay differ from the commit. - Pick a release name in the format <YEAR>.<Incrementing Number>, e.g.
2026.2. - Run
./pbi ingest <release-name>. This reruns every import from scratch, builds the release tables and stages them in the draft of Peekbank on Redivis. Nothing is staged if any dataset fails to import or validate. - Look through the draft on Redivis, or read it in PeekbankR with
peekbank("next"). If you need to apply fixes, running the ingestion command again replaces the current draft on Redivis. - Release the draft with
./pbi release <release-name>. TheReview and releasebutton on Redivis works too, but is discouraged as it does not perform the metadata validation of the command. - If desired, add the release to the curated Releases page of this website.
Extend PeekbankR
Section titled “Extend PeekbankR”You need
- a GitHub account
- either write access to peekbankr (ask the Peekbank team) or your own fork to open pull requests from
The code and the issue tracker can be found on GitHub: peekbankr.
Extend this website
Section titled “Extend this website”You need
- a GitHub account
- either write access to peekbank-website (ask the Peekbank team) or your own fork to open pull requests from
The code and the issue tracker can be found on GitHub: peekbank-website.