Skip to content

Commit

Permalink
Add dash versions of underscore params (ME-ICA#1147)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsalo authored Nov 16, 2024
1 parent 547e036 commit 6438dfa
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ independant and identically distributed (IID),
and signal leakage from in-slice and multi-slice accelleration may violate this assumption.

We have one option that is generally useful and is also a partial solution.
``--ica_method robustica`` will run `robustica`_.
``--ica-method robustica`` will run `robustica`_.
This is a method that, for a given number of PCA components,
will repeatedly run ICA and identify components that are stable across iterations.
While running ICA multiple times will slow processing, as a general benefit,
Expand All @@ -152,7 +152,7 @@ but is still sensitive to the intial number of PCA components.
For example, for a single dataset 60 PCA components might result in 46 stable ICA components,
while 55 PCA components might results in 43 stable ICA components.
We are still testing how these interact to give better recommendations for even more stable results.
While the TEDANA developers expect that ``--ica_method robustica`` may become
While the TEDANA developers expect that ``--ica-method robustica`` may become
the default configuration in future TEDANA versions,
it is first being released to the public as a non-default option
in hope of gaining insight into its behaviour
Expand Down
2 changes: 2 additions & 0 deletions tedana/workflows/tedana.py
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ def _get_parser():
default=None,
)
optional.add_argument(
"--ica-method",
"--ica_method",
dest="ica_method",
help=(
Expand Down Expand Up @@ -226,6 +227,7 @@ def _get_parser():
default=DEFAULT_SEED,
)
optional.add_argument(
"--n-robust-runs",
"--n_robust_runs",
dest="n_robust_runs",
metavar="[5-500]",
Expand Down

0 comments on commit 6438dfa

Please sign in to comment.