Add table explaining changes to report?

[sbreitbart-NOAA]

We are considering adding a table to asar that would document modifications to the report (i.e., changes occurring between versions of the same assessment, such as changes to the base model or interpretations of results). We'd like to hear your thoughts:

• Would this table be useful to you?
• Is it something your region would use?

Thanks for your input!

@nmfs-ost/asar-collaborators @iantaylor-NOAA @AdyanRios-NOAA @mollystevens-noaa @chantelwetzel-noaa

[iantaylor-NOAA]

@sbreitbart-NOAA, could you clarify what you mean by "modifications to the report"? Modifications from the default template? Modifications from previous reports for the same stock?

[sbreitbart-NOAA]

Sure. I'm referring to changes occurring between versions of the same assessment. For example, changes to the base model or interpretations of results.

[okenk]

Do you mean modifications to the report or modifications to the model? I personally like a bulleted list for documenting changes to the model. For changes to the report I don't think we want people to be spending time on that level of version control.

[lisaailloud-NOAA]

If you are talking about versions of the report, I think it is definitely needed to have that information somewhere but I don't know if it is better in a table or as a standalone section inside ASAR. I think it should be the first thing the reader sees after the title page so maybe it makes more sense to make it a section in ASAR ("Document History" or "Revision History") with bullets that can be toggled off if not needed? Here's an example (page 33) of what we do in the Gulf.

[iantaylor-NOAA]

Sure. I'm referring to changes occurring between versions of the same assessment. For example, changes to the base model or interpretations of results.

In terms of changes to the model between assessments, the current practice for the PFMC is to provide LOTS of information, including

• "Model changes from the last assessment:" typically a long list of bullets summarizing the changes
• "Bridging analysis:" lots of text and figures and sometimes a table showing the impact of incremental changes from the previous assessment
• Individual sections detailing the reasons and/or impact of specific changes

In terms of tables, having the ability to create a table comparing estimates parameters and/or derived quantities across assessments is important. I'm not sure that a table of qualitative things (like structural assumptions, etc.) would be better than a paragraphs or bullets for describing those changes.