Skip to content

psych-ds/example-datasets

Repository files navigation

Example Datasets for Psych-DS

This is a gallery of public datasets which have been formatted* according to the Psych-DS data standard. They primarily come from various subfields of psychology, and at the moment (early 2025) are primarily either versions of datasets that are freely available elsewhere online, or templates designed to help people create new Psych-DS datasets.

You can browse these datasets to learn more about how Psych-DS works, download one to try out the Psych-DS in-browser validator, or use them as test cases to develop tools that are designed to work with Psych-DS data.

Anyone can contribute to this project! Please have a look at the Psych-DS code of conduct for our community guidelines, and feel free to email Melissa Kline Struhl ([email protected]) with any questions about these datasets or Psych-DS more generally.

Status update: Updated 2025-04-10 in preparation for wider Psych-DS release.

*Note that there is one dataset in this repository that will not successfully validate: informative-mistakes-dataset/. That one is a small example designed to show various kinds of mistakes that will cause a dataset to fail validation. Check out its companion mistakes-corrected-dataset/ for a version that passes validation!

List of datasets

How to contribute a dataset

More about Psych-DS and additional resources

Datasets designed for testing the specification

  • Template, Complex-Metadata, Informative-Mistakes and Mistakes-Corrected datasets - Melissa Kline Struhl, updated by Brian Leonard

Real datasets contributed by researchers

  • NIH reviews - Patrick S. Forscher
  • Faces and Bodies - Lisa DeBruine
  • BFI - Ioanna Iro Eleftheriadou
  • Object Orientation - Sau-Chin Chen
  • Macrophage Conditioning - Love Ahnström
  • Safi Survey - Eduard Klapwijk

Step 1: Prepare Your Dataset

First, you'll need to create a properly structured dataset following the Psych-DS format. You can find detailed instructions for how to do this in the Getting Started guide from the Psych-DS docs.

Within the metadata file for your dataset, make sure to include a note in the description field with the date that you'll be uploading this dataset to our repository. It is also best to fill the Author field with information about yourself and your fellow authors. If you are not the author of the dataset, you can include your identity in the metadata by adding yourself in the "sdPublisher" field.

Here's a simplified example metadata file:

{
  "@context": "https://schema.org/",
  "@type": "Dataset",
  "name": "Visual Perception Study 2023",
  "description": "This dataset contains results from a visual perception experiment conducted in 2023.
                  Uploaded to the Psych-DS example repository on date XYZ",
  "author": {
    "@type": "Person",
    "givenName": "John",
    "familyName: "Doe",
    "id": "0000-0002-1825-0097" // this is an ORCID ID, e.g.
  },
  "sdPublisher": {
    "@type": "Person",
    "givenName": "Jane",
    "familyName: "Doe",
    "id": "0000-0002-3245-1127" // this is an ORCID ID, e.g.
  },
  "variableMeasured": [
    "participant_id",
    "trial_number",
    "stimulus_type",
    "response_time_ms",
    "accuracy"
  ]
}

Step 2: Validate Your Dataset

Before submitting, you must validate your dataset using the official Psych-DS validator:

  1. Visit the Psych-DS Validator
  2. Select your dataset directory
  3. Ensure that your dataset passes all validation checks
  4. If there are any errors, fix them and re-validate until your dataset passes all checks

Step 3: Submit Your Dataset via Pull Request

Once your dataset is validated, you can submit it to our repository yourself by following the instructions below.

If you run into trouble, please feel free to open an issue on this repository (see the "Issues" tab at the top of this page) and we can help you out!!

Option A: Using GitHub in the Browser

  1. Fork the Psych-DS example datasets repository
sc1 sc2
  1. Navigate to your forked repository (it should send you there automatically, but otherwise it can be found under your account's repository list with the name "example-datasets"
sc3
  1. Click "Add file" → "Upload files"
sc4
  1. Drag and drop your entire dataset directory or use the file selector
  2. Add a commit message explaining what dataset you're adding
  3. Click "Commit changes"
  4. Edit the Readme file to include yourself in the contributors section and click "Commit changes"
sc5 sc6
  1. Navigate to the "Pull requests" tab and click "New pull request"
sc7

Then:

sc8
  1. Select "base repository: psych-ds/example-datasets" and "head repository: your-username/example-datasets"
sc10
  1. Click "Create pull request"
  2. Add a title and description for your PR
  3. Click "Create pull request"

Option B: Using Git on the Command Line

  1. Fork the repository on GitHub
  2. Clone your forked repository:
    git clone https://github.com/your-username/example-datasets.git
    
  3. Copy your dataset directory into the repository
  4. Add your name and the name of your dataset the contributors list of the README file
  5. Add your changes:
    git add .
    
  6. Commit your changes:
    git commit -m "Add dataset: Visual Perception Study 2023"
    
  7. Push to your fork:
    git push origin main
    
  8. Go to GitHub and create a pull request from your new branch

What Happens After Submission?

After submitting your PR:

  1. Our team will review your dataset
  2. We may request changes if needed
  3. Once approved, your dataset will be merged into the main repository
  4. Your name will appear in the contributors list

Psych-DS is a community data standard for research in psychology and other behavioral sciences, which provides a flexible set of conventions for formatting and documenting scientific datasets. It is heavily inspired by the Brain Image Data Structure (BIDS) standard for fMRI data.

Psych-DS provides a simple and easy-to-adopt standard for organizing data in the psychological and behavioral sciences, which aims to help researchers satisfy FAIR principles for data sharing.

About

Example datasets that implement the Psych-DS specification

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 10

Languages