-
Notifications
You must be signed in to change notification settings - Fork 8
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
[Refactor]: Avoid R function names when naming FIMS parameters #412
Comments
We should go through FIMS and identify other parameter names that conflict with major R functions |
Agree in general. Another reason for changing the name of this particular parameter ("median" in the logistic function) is that it's not actually a median, or at least in rare instances would it be the median in either the X or Y direction. This parameter defines the X location of Y=0.5, but 0.5 isn't necessarily the median value. Maybe we call it x50? |
@KyleShertzer-NOAA I agree, we should be mathematically consistent. In addition, if we aren't going to treat recruitment deviations as deviations, they should also be renamed. I'm sure there are other members throughout the API that need review. |
I started a table in the issue to track parameters that need to be renamed along with any proposed names. We should do thorough search and flag any parameter names that conflict with R or have a name inconsistent with its mathematical meaning. |
Work on this was merged in with #503. |
Refactor request
From @kellijohnson-NOAA: In the future it might be good to not name parameters the same name as major functions in R.
example: test-fims-estimation.R
Expected behavior
Parameter names that do not conflict with R functions within base R or other major R functions.
Code of Conduct
The text was updated successfully, but these errors were encountered: