[Developer Issue]: inconsistent formatting of data-type names

[kellijohnson-NOAA]

Description

The available data types have inconsistent formatting in their naming structure, e.g., age_comp and length_comp versus weight-at-age. It does not really matter to me what we choose except that it should be consistent. Does anyone have a preference of underscores, dash, or space? One nice thing about underscores is that if you want to keep consistency between objects and strings, then the name results in a valid R object because it is snake_case if you use underscores but it is invalid with dashes or spaces. If we choose to use a space, e.g., "age comp" then nothing would need to be modified for a figure unless we wanted to change it to composition.

• pick a naming type, undescore, dash, or space
• change the R script to make the data, i.e., data-raw/data1.R
• change the helper functions to pull the new data type name
• update the case studies to use to use the new naming
• update the r4ss function to use the new naming
• add documentation to the R/data1.R file stating that all types use our style that we decide on

[nathanvaughan-NOAA]

I would vote for underscores to make it easier to use the names directly in R and it should be easy to add a replace underscore with space filter for plotting.

[kellijohnson-NOAA]

Thanks @nathanvaughan-NOAA we choose to go with your suggestion during Code Club today, which also proved to be extremely helpful for the wrapper functions which depend on that consistent naming using an underscore so it was a WIN 🥇. We also added a package object that stores the available data types as a vector of strings to use for both validation and to help inform users.

[nathanvaughan-NOAA]

Awesome! Sorry I couldn't make it, sounds like the monthly longer code clubs are paying off 🥳

[ayushk687]

@kellijohnson-NOAA please assign this issue to me
thanks