Clean up exports about mmrm HOT 6 CLOSED

btw I think we can't and don't need to export the example data set. with the lazy data loading it is available to the user.

btw 2: see also recent insightsengineering/tern.mmrm#87 which was cleaning up tern.mmrm in a similar way.

from mmrm.

It's probably easier to decide what will be exported rather than what won't be.
From my view these need to be exported:

• all methods for mmrm and mmrm_tmb objects.
• component so that users can access parts of the model object which do not have generic s3 methods.
• mmrm
• h_mmrm_tmb
• fev_data

I'm unsure about the fitting routines, which seem like they could potentially be useful to users, but maybe in some sort of other wrapper? refit_multiple_optimizers() takes a mmrm_fit object and could be

The rest of the functions (emmeans.R, output.R, parallel.R, satterthwaite.R) seem like they could all be internal. What's your perspective on this?

from mmrm.

Thanks @BrianLang for starting on this one!

Yeah agree there are much fewer things to export than not. I agree with your list so far!

For the others:

• tmb: I would also export h_mmrm_tmb_control() such that the user who uses h_mmrm_tmb() directly can manage those settings
• fitting routines: I think it is sufficient to only export mmrm()
• parallel: I would export h_free_cores() since it is called in tern.mmrm downstream directly
• Satterthwaite stuff: I would export df_1d() and df_md() (because it is nice to be able to do this without extra packages if wanted)

from mmrm.

Great feedback, thanks! Forgot that one with 'control()'

from mmrm.

Would like some feedback:

1. on how we choose badges. Right now everything is still external.
2. on if we really get rid of all mention of non-exported functions from the _pkgdown. as it is now, they are separated into "helper functions" and "functions".
3. refit_multiple_optimizers and fit_single_optimizer are both in the _pkgdown.yml as functions, but I've just removed them from exports. are we still in favor of having them internal?

Thanks!

from mmrm.

Thanks @BrianLang !

• Badges: yes that is right since this is the first package version let's have everything as experimental. In next version we can then upgrade to stable
• Yeah let's get rid of internal functions in pkgdown
• OK let's keep these two additional fitting functions exported

from mmrm.