BIDSCOIN(1)

📦
version 4.6.2 · 2 versions
, in fedora 43

💖 BIDSCOIN(1) 💖

okay bestie, buckle up, we're reading a manpage and it's actually gonna be cute. this is bidscoin, from the Generated Python Manual collection, and she's a whole icon. ✨

🌸 NAME 🌸

bidscoin — the main character, the it-girl, the entry point 🫶

🌈 SYNOPSIS 🌈

bidscoin [-h] [-l] [-p] [-i NAME [NAME ...]] [-u NAME [NAME ...]] [-d
FOLDER] [-t [TEMPLATE]] [-b BIDSMAP] [-c OPTIONS [OPTIONS ...]] [-r]
[--tracking {yes,no,show}] [-v]

that's a lot of little bracket babies but don't panic, we're gonna go through every single one. no skips, no shortcuts. 💅

✨ DESCRIPTION ✨

first of all, the logo. we stan a brand with a vibe:

  ,-----.  ,--.,------.   ,---.               ,--.
  |  |) /_ |  ||  .-.  \ '   .-'  ,---. ,---. `--',--,--,
  |  .-.  \|  ||  |  \  :`.  `-. | .--'| .-. |,--.|      \
  |  '--' /|  ||  '--'  /.-'    |\ `--.' '-' '|  ||  ||  |
  `------' `--'`-------' `-----'  `---' `---' `--'`--''--'

BIDScoin is a toolkit to convert raw data-sets according to the Brain Imaging Data Structure (BIDS). literally doing the lord's work for neuroimaging besties everywhere 🧠✨

🦋 the basic workflow (aka the two-step slay)

you run these two tools and you're basically done:

$ bidsmapper sourcefolder bidsfolder     # This produces a study bidsmap and launches a GUI
$ bidscoiner sourcefolder bidsfolder     # This converts your data to BIDS according to the study bidsmap

first one maps, second one coins. iconic duo behavior, honestly. 👑

🎀 where all the settings live

Default settings, plugins and template bidsmaps are stored in the .bidscoin configuration folder in your home directory 💖 (and yes, you can modify the configuration files to your needs with any plain text editor — go off, customize your little heart out).

💜 the environment variables (iykyk)

  • Set BIDSCOIN_DEBUG=TRUE to run BIDScoin in a more verbose logging mode 👀 — she'll tell you EVERYTHING.
  • Set BIDSCOIN_CONFIGDIR=/writable/path/to/configdir for using a different configuration (root) directory.
  • Citation reports can be generated with the help of duecredit (https://github.com/duecredit/duecredit) 📚 — cite your sources, academic bestie!

🌈 more docs

For more documentation see: https://bidscoin.readthedocs.io — she has lore, go read it.

💅 OPTIONS 💅

every flag, accounted for. we do NOT leave options behind in this house.

  • -l, --list — List all executables (i.e. the apps, bidsapps and utilities). a full roster reveal 🎬
  • -p, --plugins — List all installed plugins and template bidsmaps. show me what you're working with, bestie ✨
  • -i NAME [NAME ...], --install NAME [NAME ...] — A list of template bidsmaps and/or bidscoin plugins to install. yes, you can pass a whole list, she's flexible like that 💖
  • -u NAME [NAME ...], --uninstall NAME [NAME ...] — A list of template bidsmaps and/or bidscoin plugins to uninstall. it's giving spring cleaning 🧹
  • -d FOLDER, --download FOLDER — Download tutorial MRI data to the DOWNLOAD folder. free data?? we love free data 🎁
  • -t [TEMPLATE], --test [TEMPLATE] — Test the bidscoin installation and template bidsmap. vibe check, but for software ✅
  • -b BIDSMAP, --bidsmaptest BIDSMAP — Test the run-items and their bidsnames of all normal runs in the study bidsmap. Provide the bids-folder or the bidsmap filepath. two ways to hand it over, pick your fighter 🥊
  • -c OPTIONS [OPTIONS ...], --credits OPTIONS [OPTIONS ...] — Show duecredit citations for your BIDS repository. You can also add duecredit summary arguments (without dashes), e.g. style {apa,harvard1} or format {text,bibtex}. give the people their credit, fr fr 🙌
  • -r, --reset — Restore the settings, plugins and template bidsmaps in your home directory to their default values. factory reset era, no cap 🔄
  • --tracking {yes,no,show} — Show the usage tracking info {show}, or set usage tracking to {yes} or {no}. your data, your call, bestie 🕵️
  • -v, --version — Show the installed version and check for updates. is she up to date? let's find out 👑

🍓 COMMENTS 🍓

examples, aka the receipts, aka copy-paste fuel:

bidscoin -l
bidscoin -d data/bidscoin
bidscoin -t
bidscoin -t my_template_bidsmap
bidscoin -b my_study_bidsmap
bidscoin -i data/my_template_bidsmap.yaml downloads/my_plugin.py
bidscoin -c myproject/bids format bibtex
bidscoin --tracking show

look at her go. so many tricks. 🦋

👑 AUTHOR 👑

Marcel Zwiers <m.zwiers@donders.ru.nl> — the legend behind the legend 💜 thank you for your service, king.

heads up bestie: keep those commands EXACTLY as written. no creative spelling, the terminal does not appreciate freestyling. 💀

okay that's the whole page, and honestly? she ate. this was bidscoin 4.6.2, dated 2025-11-06, and yes we're signing off with full main character energy. go convert some data, bestie, you've got this. periodt. 💖✨🎀

📦 where this page comes from