Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename R2s parameter in hmri_defaults #76

Open
Barisevrenugur opened this issue Aug 15, 2023 · 2 comments
Open

Rename R2s parameter in hmri_defaults #76

Barisevrenugur opened this issue Aug 15, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@Barisevrenugur
Copy link
Contributor

Barisevrenugur commented Aug 15, 2023

(after discussion with @lukeje ) Due to multiple different R2* estimation algorithms (e.g. OLS, WLS and NLLS), drop the name-dependence of the parameter on a specific method (i.e. OLS): rename the parameter on line LineToBeChanged possibly to hmri_def.R2estatics and implement the required changes in hmri_create_MTPROT.m

@Barisevrenugur Barisevrenugur added the enhancement New feature or request label Aug 15, 2023
@lukeje
Copy link
Member

lukeje commented Aug 15, 2023

One point which we will need to bear in mind is that changing parameter names in the defaults file will break backwards compatibility. We will thus need to make this change very clear to users downloading the new version. As far as I know, though, people don't normally disable ESTATICS, so we should be OK in most cases.

@lukeje
Copy link
Member

lukeje commented Aug 15, 2023

Also, I realised the context is missing. We have a boolean parameter which for historical reasons is called R2sOLS to turn on ESTATICS. However this is confusing now that we have multiple different R2* estimation algorithms (e.g. OLS, WLS and NLLS). It would therefore be a good idea to rename the parameter to turn on ESTATICS to something less confusing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants