DOC: Automatic flowchart

[larsoner]

Before merging …

• Changelog has been updated (docs/source/changes.md)

Locally produces:

@hoechenberger feel free to push directly wording changes you want. Locally you can iterate pretty easily with:

~/python/mne-bids-pipeline/docs/site$ python -m http.server
~/python/mne-bids-pipeline/docs/site$ ../build_docs.sh

then refreshting http://localhost:8000/features/overview.html in your browser.

[larsoner]

@SophieHerbst can you see if this fixes the wording issue(s) you ran into or if there is more to do?

[hoechenberger]

Should we check all code that generates output filenames to ensure we set split=None everywhere?

[larsoner]

I think we could do it in the function that prepares the output filenames actually. I'll give it a shot

[larsoner]

Should be working now!

[SophieHerbst]

@larsoner is the 'temporal regression for artifact removal' a default step? I am not aware that I am using it.
If not, I think it should be marked as optional.

[hoechenberger]

most of the steps are optional though.... we'd end up with almost everything being marked as such

[SophieHerbst]

mh right. I am wondering how to make it clearer which config options trigger which steps (or their re-run)

[hoechenberger]

there are get_config() functions in every step now which cover almost all configuration options that affect this step (exceptions are I believe n_jobs, subjects and session, but i'm not 100% certain from the top of my head)

in theory this information could be used

[SophieHerbst]

Used as in informing the documentation?
(I learned about this part last week, when I forgot to mention the image_kwargs for the report there; easy to make mistakes as it needs to be added manually)

[hoechenberger]

Used as in informing the documentation?

Yes

We'd basically have to iterate over all steps and grep the arguments used in get_config() and then put that in a table or so…

[larsoner]

Opened #862 and #861 so we can iterate further in follow-up PRs. This one in the meantime is 90% a bugfix for missing / incorrect information at the moment (the other 10% being the ICA/SSP enhancement to try and make that part clearer) -- @SophieHerbst @hoechenberger happy with those parts so we can merge this?

[larsoner]

https://output.circle-artifacts.com/output/job/d69d1de1-f4fc-4714-9d6e-f43e8f3816b7/artifacts/0/site/features/overview.html

[hoechenberger]

yes, this is great! feel free to merge whenever you feel it's ready 👍👍👍