Open kylebaron opened 2 years ago
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.
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.
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 tonmfe
. I believe that seeing the available options fornmfe
requires users to work throughbbi_args
and calling thatprint_bbi_args()
function and identifying items asnmfe
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 whensubmit_model(mod)
is called. I do think it is the right call to default tomaxlim=2
but as a user it would be helpful to know that is happening in thesubmit_model
documentation. I recognize that this is owned bybbi
we want to document in only one place, but I doubtbbr
users are going tobbi
documentation to learn this information.What do you think about an Rd help page or vignette that reviews the connection between
bbr
andnmfe
and makes sure people callingsubmit_model()
can know what defaults are in play when the call this.