SSMSE icon indicating copy to clipboard operation
SSMSE copied to clipboard

Change column names per r4ss updates

Open e-perl-NOAA opened this issue 1 year ago • 11 comments

Column header updates in r4ss in PR #945 will require updates in SSMSE functions such as those with FltSvy.

Additional changes in r4ss headers can be found in the PR files changed. Other ss3 names have changed - see r4ss commit for changes from F_report_basis to F_std_basis, F_report_units to F_std_units, SPR_report_basis to SPR_std_basis, and SPR_report to SPR_std.

e-perl-NOAA avatar Jul 29 '24 18:07 e-perl-NOAA

I'm currently trying to fix this.

I think there are 3 approaches possible

  1. SSMSE only works with r4ss < 1.50.0 (before the breaking changes)
  2. SSMSE only works with r4ss >= 1.50.0 (after the breaking changes)
  3. SSMSE works with either version of r4ss, taking into account the different names.

I'm currently thinking 2) may be the best option moving forward, as maintaining both sets of column names will be cumbersome. It is fairly straightforward for users to update to a newer version of r4ss (a little more difficult to roll back to an older version), and the newer names in r4ss are more consistent and clear.

If anyone disagrees, please feel free to chime in!

k-doering-NOAA avatar Jul 30 '24 17:07 k-doering-NOAA

@k-doering-NOAA I agree that option 2 is probably the best solution. We should also add a requirement in SSMSE for r4ss>=1.50.0 so that users get an alert if they have an incompatible r4ss version.

nathanvaughan-NOAA avatar Jul 30 '24 18:07 nathanvaughan-NOAA

@nathanvaughan-NOAA thanks, I'm glad you agree!

I realized this is straightforward, but a little tricky because the SSMSE sample_struct object does not match with the r4ss names always, only sometimes, and I don't think we want to change the sample_struct names. Therefore, we'll need to find and replace ONLY the r4ss column names and not the original column names in sample_struct.

Alternatively, we could make the sample_struct names also match with the new r4ss names, which are more consistent and clear. This would be a breaking change in SSMSE, though.

k-doering-NOAA avatar Jul 30 '24 19:07 k-doering-NOAA

@k-doering-NOAA I'm busy at the Gulf SSC meeting for the next few days but I was thinking the same thing about the sample_struct naming issue. We have added a bunch of options to that for discards and custom MS inputs. Let me check in with @skylersagarese-NOAA, @CassidyPeterson-NOAA, @latreesedenson-NOAA, and @matthewsmith-NOAA when I get back for their thoughts. This could be a good opportunity to clean up name matches.

nathanvaughan-NOAA avatar Jul 31 '24 01:07 nathanvaughan-NOAA

@nathanvaughan-NOAA, I just wanted to circle back to this to see if there is a particular solution that you would like to go with so that the capability to work with 3.30.21 can maybe move forward.

e-perl-NOAA avatar Oct 31 '24 14:10 e-perl-NOAA

Thanks @e-perl-NOAA I'll check in with the rest of the SEFSC SSMSE folks again to see if we have an idea of when the best time would be to make the transition.

nathanvaughan-NOAA avatar Oct 31 '24 14:10 nathanvaughan-NOAA

Resolve this within the next month

k-doering-NOAA avatar Apr 22 '25 21:04 k-doering-NOAA

@k-doering-NOAA it would be nice for me if we could have a co-working session where we fix this in SSMSE and ss3sim at the same. If you are willing to do that, feel free to add something to my calendar at a time that is convenient for you.

kellijohnson-NOAA avatar May 09 '25 13:05 kellijohnson-NOAA

That sounds great! I sent a meeting invite.

k-doering-NOAA avatar May 09 '25 16:05 k-doering-NOAA

@kellijohnson-NOAA and I will finish changes in SSMSE and ss3sim by COB 5/19

k-doering-NOAA avatar May 13 '25 21:05 k-doering-NOAA

@k-doering-NOAA the column names have also changed in CPUEinfo to fleet units errtype SD_report

kellijohnson-NOAA avatar May 13 '25 22:05 kellijohnson-NOAA