[Feature]: Design names for output labels

[k-doering-NOAA]

Is your feature request related to a problem? Please describe.

Need a system for output labels. More info can be found in the M2 design reviews google doc

Describe the solution you would like.

How labels get reported in TMB: Andrea: derived quantity names wrapped in SDREPORT get carried through to output. Parameter names are more challenging as these carry the label ‘p’ although anything wrapped in REPORT will also carry its name to output. Currently, reporting happens from model.hpp which loops over all populations, fills nested vectors with output which gets returned to the user. I’m happy to set up some time with the output group to go over the current state of reporting in FIMS

• Maybe we need a function (e.g., pretty_labels()) to format the labels and make them more human-readable for users?
• As for a specific style, maybe we could use the naming scheme from {broom}? I’ve noticed other packages using the various functions (e.g., insight::standardize_names() and parameters::format_parameters()) to convert output names using different styles.

Tasks

• Research what other models use for parameters symbols, e.g., is there a universal symbol for selectivity? A glossary of some statistical terms such as $p$ for proportion and $P$ for probability could be helpful. As well as the data dictionary paper in review (ask Christine or Kelli).
• Implement style guide separator of "_" for spaces and "-" for groups of words
• Create a dictionary of parameter names to symbols/abbreviations, e.g., natural mortality, $M$
• Ensure that "reserved" combinations of letters are not used such as "c" or "stop" in R
• Modify code base to use symbols/abbreviations such that R input, C++ code, and R output all use the same names

[k-doering-NOAA]

#482 may potentially provide some relevant details.