Some way to refer to the models (and data structures) in the package?

[athowes]

In PR #447 I suggested adding documentation like:

#' @param data An object with class corresponding to an implemented model.
#' The currently available models classes are `epidist_latent_model` and
#' `epidist_naive_model`.

I think this is fine for now but really we don't want to have to be updating documenation like this when we add a new model.

Instead, I think perhaps we could have some kind of data object or function in the package which lists the available models. Then in documentation we say that you can call epidist_model_classes() to look at them. Or for the data ones we can say that they can call epidist_data_classes().

What do you think @seabbs? I think this is something you've probably encountered before.

[athowes]

Here's a possible design:

> epidist_models <- function() {
+   all_objects <- ls(asNamespace("epidist"))
+   model_functions <- grep("^as_epidist_.*_model$", all_objects, value = TRUE)
+   model_names <- sub("^as_epidist_([a-z_]+)$", "\\1", model_functions)
+   unique(model_names)
+ }
> epidist_models()
[1] "latent_model"   "marginal_model" "naive_model"   

Could do similar for data classes.

[seabbs]

Yes could do. Maybe in the first instance though we jus want to have aim for a vignette that lists the models in a single place and then point to that?

[athowes]

I don't know about refering to vignettes from the roxygen (whether it's possible)

[seabbs]

it is I think using vignettes("name of vignette")