========================================
BIDScoin: Coin your imaging data to BIDS
.. image:: ../bidscoin/bidscoin_logo.png
:height: 260px
:align: right
:alt: Full documentation: https://bidscoin.readthedocs.io
:target: https://bidscoin.readthedocs.io
|PyPI version| |Neurodesk| |BIDS| |Python Version| |GPLv3| |RTD| |Tests| |DOI|
BIDScoin is a user-friendly Python application suite that converts ("coins") source-level (raw) neuroimaging data sets to standardized data sets that are organized according to the Brain Imaging Data Structure (BIDS <https://bids-specification.readthedocs.io>
) specification. Rather than depending on complex programmatic logic for source data-type identification, BIDScoin uses a mapping approach to discover the different source data types in your repository and convert them into BIDS data types. Different runs of source data are uniquely identified by their file system properties (e.g. file name or size) and by their attributes (e.g. ProtocolName
from the DICOM header). Mapping information can be pre-specified (e.g. per site), allowing BIDScoin to make intelligent first suggestions on how to classify and convert the data. While this command-line procedure exploits all information available on disk, BIDScoin offers a Graphical User Interface (GUI) <./screenshots.html>
for researchers to check and edit these mappings -- bringing in the missing knowledge that often exists in their heads only. This interactive step can also be skipped for employment in fully automated dataflow pipelines.
Data conversions are performed within plugins, such as plugins that employ dcm2niix <https://github.com/rordenlab/dcm2niix>
, spec2nii <https://github.com/wtclarke/spec2nii>
or nibabel <https://nipy.org/nibabel>
__.
BIDScoin requires no programming knowledge in order to use it, but users can use regular expressions and plug-ins to further enhance BIDScoin's power and flexibility, and readily handle a wide variety of source data types.
BIDScoin is developed at the Donders Institute <https://www.ru.nl/donders/>
__ of the Radboud University <https://www.ru.nl/en>
__.
Features
.. note::
- All source code is hosted at
GitHub <https://github.com/Donders-Institute/bidscoin>
__ and freely available under the GPL-3.0-or-later license <https://spdx.org/licenses/GPL-3.0-or-later.html>
__. - The full BIDScoin documentation is hosted at
Read the Docs <https://bidscoin.readthedocs.io>
__ - For citation and more information, see our
BIDScoin publication <https://www.frontiersin.org/articles/10.3389/fninf.2021.770608>
__ in Frontiers in Neuroinformatics (DOI: 10.3389/fninf.2021.770608 <https://doi.org/10.3389/fninf.2021.770608>
). See here <./plugins.html>
for citations of the plugins. A custom-made citation report can be generated with the help of duecredit <https://github.com/duecredit/duecredit>
__ - You are encouraged to post issues or questions at
GitHub <https://github.com/Donders-Institute/bidscoin/issues>
__ or NeuroStars <https://neurostars.org/tag/bidscoin>
__ (tag: #bidscoin)
How to contribute
Are you a Python programmer with an interest in BIDS who knows about GE and/or Philips data? Are you experienced with parsing stimulus presentation log-files? Or do you have ideas to improve BIDScoin or its documentation? Have you come across bugs? In any case, you are more than welcome to provide feedback and to contribute to this project <https://github.com/Donders-Institute/bidscoin/blob/master/CONTRIBUTING.rst>
__.
.. |PyPI version| image:: https://img.shields.io/pypi/v/bidscoin?color=success
:target: https://pypi.org/project/bidscoin
:alt: BIDScoin
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/bidscoin.svg
:alt: Python 3
.. |Neurodesk| image:: https://img.shields.io/badge/Neurodesk-green
:target: https://www.neurodesk.org/docs/overview/applications/
:alt: Neurodesk
.. |GPLv3| image:: https://img.shields.io/badge/License-GPLv3+-blue.svg
:target: https://www.gnu.org/licenses/gpl-3.0
:alt: GPL-v3.0 license
.. |RTD| image:: https://readthedocs.org/projects/bidscoin/badge/?version=latest
:target: https://bidscoin.readthedocs.io/en/latest/?badge=latest
:alt: Documentation status
.. |DOI| image:: https://img.shields.io/badge/doi-10.3389%2Ffinf.2021.770608-informational.svg
:target: https://www.frontiersin.org/articles/10.3389/fninf.2021.770608
:alt: DOI reference
.. |BIDS| image:: https://img.shields.io/badge/BIDS-v1.10.0-blue
:target: https://bids-specification.readthedocs.io/en/v1.10.0/
:alt: Brain Imaging Data Structure (BIDS)
.. |Tests| image:: https://github.com/Donders-Institute/bidscoin/actions/workflows/tests.yaml/badge.svg
:target: https://github.com/Donders-Institute/bidscoin/actions
:alt: Pytest results