mSSA boolean flags for totPow and totVar can lead to wrong parameters

[sophialilleengen]

The totVar and totPow flag parameters are set to true based on existing rather than the boolean defined in the input flag string here. If a user explicitly sets a flag to false this might lead to issues. Ideally, change the code to check that the param exists and is true. Alternatively, add a warning when a param is set to false or a very clear and easy-to-find flag documentation that explains which flags are set to true by default and which ones should only be used when setting to true.

[The9Cat]

Good point/catch, thanks! These are currently undocumented parameters that I considered to be experimental. So they are not officially part of the pyEXP API. As a consequence, I didn't document them in case we wanted a more general detrending strategy with different or additional options.

However, I know that we have recommended that you (and others) try them in various contexts. So, should we consider adding these permanently?

If these seem useful and people feel that we should keep them, it would be easy to change these into boolean variables to be consistent with other YAML configuration parameters. And that would be my choice if we decide to make them official.

@michael-petersen What's you sense of this?

[michael-petersen]

I think we've demonstrated at this point that totPow and totVar can be promoted. See a test of this in #133, and discussion happening there.

[The9Cat]

Fixed in #133.