BIDSPARTICIPANTS(1)

📦
version 4.6.2 · 2 versions
, in fedora 43

🎀 BIDSPARTICIPANTS 🎀

okay so this is a page from the Generated Python Manual — yes bestie, that's the manual name, we're fancy like that 💅 — and it's all about a little tool called bidsparticipants. Let's get into it.

✨ NAME ✨

bidsparticipants — that's it, that's the name, iconic 🫶

🌸 SYNOPSIS 🌸

bidsparticipants [-h] [-d] [-b NAME] sourcefolder bidsfolder

🦋 DESCRIPTION 🦋

So here's the vibe: it (re)scans the data sets in the sourcefolder looking for subject metadata, and then it uses that to populate the participants.tsv file over in the bids directory. When do you need this? Like, whenever you've been messing around in the bids folder yourself — renamed stuff (be careful there! 😭), added stuff, deleted stuff. It comes through and fixes the participants file back up for you. 💖

Provenance information, warnings and error messages all get stashed in the bidsfolder/code/bidscoin/bidsparticipants.log file, so if something's giving suspicious, that's where you go snooping. 🔍

Here are the two folder args, bestie:

  • sourcefolder — the study root folder containing the raw source data folders 🌱
  • bidsfolder — the destination/output folder with the bids data 📦

💅 OPTIONS 💅

  • -d, --dryrun — do not save anything, only print the participants info on screen. Nothing gets written, it's just a lil preview moment. 👀
  • -b NAME, --bidsmap NAME — the study bidsmap file with the mapping heuristics. Now listen closely: if the bidsmap filename is just the base name (i.e. there's no / in the name), then it's assumed to be located in the current directory or in bidsfolder/code/bidscoin. Default: bidsmap.yaml 🌈

💀 COMMENTS 💀

examples, because sometimes you just need to see it:

bidsparticipants myproject/raw myproject/bids
bidsparticipants myproject/raw myproject/bids -b mybidsmap

👑 AUTHOR 👑

Marcel Zwiers <m.zwiers@donders.ru.nl> — the legend, the moment, the main character 🎀

And that's the whole page, bestie — this was bidscoin 4.6.2, dated 2025-11-06, and honestly? Slay. ✨ Go populate those participants.tsv files. Byeee 🦋💖

📦 where this page comes from