Documentation of nmfe options that can be set via `.bbi_args`

[kylebaron]

Summary

Opening this up to get some discussion based on recent activity in bbi

https://github.com/metrumresearchgroup/bbi/pull/279 https://github.com/metrumresearchgroup/bbi/issues/263

For someone using bbr, it isn't obvious how to pass args to nmfe. I believe that seeing the available options for nmfe requires users to work through bbi_args and calling that print_bbi_args() function and identifying items as nmfe options.

With this change https://github.com/metrumresearchgroup/bbi/pull/279 I feel like there is additional motivation to help bbr users understand what is happening when submit_model(mod) is called. I do think it is the right call to default to maxlim=2 but as a user it would be helpful to know that is happening in the submit_model documentation. I recognize that this is owned by bbi we want to document in only one place, but I doubt bbr users are going to bbi documentation to learn this information.

What do you think about an Rd help page or vignette that reviews the connection between bbr and nmfe and makes sure people calling submit_model() can know what defaults are in play when the call this.

[kyleam]

Haven't looked too closely at the bbr side yet, but in general an Rd doc that ties together the different pieces sounds like a good idea.

[seth127]

I'm going to bump this to the next release, but I think it's a great idea. I would push for moving this specific section out of the "Getting Started" vignette and into its own vignette. This new vignette can get into more detail about the nmfe options that you mention.