Open athowes opened 1 month ago
If we include all methods for a given generic in a single Rd then that means it will need to be updated to document any additional models. It also means that any user models (i.e. in a extension package will be documented differently). I think personally I would prefer to have separate docs per method but link them all via the @family tag?
Decide how to do website family grouping
Agree
Decide how to group R files
I would prefer that all methods for a given model are in the same file as this will make it easier for people to find all the source code they need and easier to write their own methods (they copy one file and rename + update vs searching the whole package).
Better handling of ... in S3 generics
This feels like its own issue.
Right now we have:
I'd propose that we move to grouping the documentation together for generic functions and methods. See #74 for other options / discussion on
scoringutils
.This would involve:
@rdname generic_function
to all methods associated with a given generic functionepidist
,epidist_family
,epidist_formula
, ... and 2) a section "Constructors" foras_latent_individual
,is_latent_individual
,validate_latent_individual
, ... (and all future model constructors)modelling.R
andconstructors.R
as aboveOther things that could be handled as a part of a PR closing this documentation: