Skip to content

A utility repository for BIDS phenotypic data conversion, aggregation, and segregation.

License

Notifications You must be signed in to change notification settings

karl-koschutnig/bids-phenotype

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

BIDS phenotypic data guidelines converter

A utility repository for BIDS phenotypic data conversion, aggregation, and segregation.

Motivation

Based on the BIDS guidelines for phenotypic data ([read the doc](PUT LINK HERE) or [view the poster](PUT LINK HERE)), this tool is meant to prepare your phenotypic data for BIDS. It can do the following three things:

  1. Convert CSV or Excel files to BIDS TSV files in a phenotype/ folder.
  2. Segregate already-prepared phenotype TSV files into subject or session folders.
  3. Aggregate already-prepared phenotype TSV files from subject or session folders to a top-level phenotype/ folder.

Help: python phenotype.py -h

usage: phenotype.py [-h] {convert,segregate,aggregate} ...

BIDS phenotype data utility

positional arguments:
  {convert,segregate,aggregate}
                        Modes
    convert             Convert CSV or Excel files to BIDS TSV files
    segregate           Segregate phenotype files from the top of the tree
    aggregate           Aggregate phenotype files to the top of the tree

optional arguments:
  -h, --help            show this help message and exit

(UNTESTED) Conversion: python phenotype.py convert -h (UNTESTED)

usage: phenotype.py convert [-h] -i INDIR -o OUTDIR

optional arguments:
  -h, --help            show this help message and exit
  -i INDIR, --input-dir INDIR
                        Input directory of CSVs and/or Excel files.
  -o OUTDIR, --output-dir OUTDIR
                        Output directory to write converted files which can be the same as the input directory

Segregation: python phenotype.py segregate -h

usage: phenotype.py segregate [-h] -i INDIR -o OUTDIR {subject,session}

positional arguments:
  {subject,session}     Segregate to either the subject or session level

optional arguments:
  -h, --help            show this help message and exit
  -i INDIR, --input-dir INDIR
                        Input BIDS top-level/root directory containing the phenotype folder
  -o OUTDIR, --output-dir OUTDIR
                        Output directory to write segregated files which can be the same as the input directory

Aggregation: python phenotype.py aggregate -h

usage: phenotype.py aggregate [-h] -i INDIR -o OUTDIR {subject,session}

positional arguments:
  {subject,session}     Aggregate from either the subject or session level

optional arguments:
  -h, --help            show this help message and exit
  -i INDIR, --input-dir INDIR
                        Input BIDS top-level/root directory containing the subject/session segregated phenotype folders
  -o OUTDIR, --output-dir OUTDIR
                        Output directory to write aggregated files which can be the same as the input directory

About

A utility repository for BIDS phenotypic data conversion, aggregation, and segregation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%