Add examples to exported functions

[jamesmbaazam]

The key exported functions could benefit from having examples. I've noted as_latent_individual(), which tends to be called as the first step before epidist(). The latter, epidist(), also could benefit from the same suggestion.

[athowes]

I agree that we should add examples! Thanks for the suggestion, and for having a look at the package in these early stages more generally

[jamesmbaazam]

It's a pleasure. It's coming along nicely.

[athowes]

Note to self that this is a good one to work on soon.

[athowes]

The first step here is to make certain data objects available. Perhaps this could also be used to simplify things being available within tests.

[athowes]

@seabbs is this something we might want to consider as a part of public release?

[jamesmbaazam]

You'll need to do it if submitting to CRAN. It's a requirement.

[athowes]

Thanks @jamesmbaazam. The plan we have is an inital "public" release on GitHub / R Universe next week. (After a temporary "internal" release tomorrow.) So I think CRAN is a bit longer into the future. Nonetheless I think this is a useful feature (especially for new users to the package) and it'd be nice to have sooner rather than later.

[athowes]

PRs welcome if it's something you might feel up for tackling as part of your work!

[seabbs]

Mostly done in #513

[seabbs]

Im going to close this in favour of more targetted issues at remaining gaps