Name of fitting function

vast-lib / tinyVAST

Expressive interface for multivariate spatio-temporal models

https://vast-lib.github.io/tinyVAST/

GNU General Public License v3.0

10 stars 2 forks source link

Name of fitting function #8

Closed seananderson closed 8 months ago

seananderson commented 9 months ago

I wonder if a more expressive, identifying, and branded(?) function than fit() would be a good idea. Something that makes it obvious what the user is doing when multiple packages are loaded and this call appears in the middle of a long sequence of code. Plus, since it's not an S3 method here, it's liable to get clobbered by other packages or code. And some people (like me!) like to use fit as a default fitted object. tinyVAST() or vast() are obvious ones, but maybe there's something else ingenious that works. vastize()? :stuck_out_tongue:

I don't know. I could be convinced otherwise. I just think it could be more elegant with something else.

James-Thorson-NOAA commented 8 months ago

What about renaming:

fit -> tinyVAST (which matches practice in sdmTMB and glmmTMB, and dsem, but violates the verb_noun convention that I try to use for other functions).
Keep the S3-class outputted as tinyVAST (which seems to match the convention in sdmTMB and glmmTMB)

I think this is straightforward, so I'll do it now on the main branch.