physiopy / phys2denoise

A toolbox and collection of scripts to prepare physiology data for fMRI denoise
https://phys2denoise.readthedocs.io/
Apache License 2.0
9 stars 19 forks source link

Allow YAML-based config file with input arguments from/for workflow #29

Open tsalo opened 3 years ago

tsalo commented 3 years ago

We want to add the ability to ingest and write out YAML-based config files when running the workflow.

Stems from https://github.com/physiopy/phys2denoise/pull/17#discussion_r530673815 and GatherTown convo.

Detailed Description

Running the workflow will automatically write out a YAML file to the output directory with all arguments used in the original call. Users will also be able to feed in a --config-file argument that will take parameters from a YAML file and use them in the workflow call. Any manually specified arguments will override ones in the YAML file (perhaps with a warning?).

Context / Motivation

This will make it easier to re-run the workflow, as well as to run the workflow on many participants with limited variable hard-coding.

Possible Implementation