Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document epidist_latent_individual class specific functions #74

Closed
athowes opened this issue Jun 6, 2024 · 3 comments
Closed

Document epidist_latent_individual class specific functions #74

athowes opened this issue Jun 6, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation high Required for next release

Comments

@athowes
Copy link
Collaborator

athowes commented Jun 6, 2024

The epidist_latent_individual class functions are currently not well documented.

I do not have a perfect picture of how to handle documenting instances of methods. (Also what the name is for functions like this e.g. epidist_prepare.epidist_latent_individual.)

As a part of 1. finding out best practise here 2. implementing then I'd also want the roxygen2 website to display nicely (e.g. grouping together class specific functions?).

See #70.

@athowes athowes added the documentation Improvements or additions to documentation label Jun 6, 2024
@athowes athowes self-assigned this Jun 6, 2024
@athowes athowes mentioned this issue Jun 6, 2024
9 tasks
@seabbs
Copy link
Contributor

seabbs commented Jun 6, 2024

you can have a look at scoringutils here for one approach and there is a issue arguing about this (will look for)

@athowes
Copy link
Collaborator Author

athowes commented Jun 17, 2024

I think the issue arguing about this might be epiforecasts/scoringutils#793

@athowes athowes changed the title Document epidist_ltcad class specific functions Document epidist_latent_individual class specific functions Jun 24, 2024
@athowes athowes mentioned this issue Jul 30, 2024
18 tasks
@athowes athowes removed their assignment Aug 8, 2024
@athowes athowes added the high Required for next release label Aug 8, 2024
@athowes
Copy link
Collaborator Author

athowes commented Nov 6, 2024

Closing as outdated / non-actionable.

@athowes athowes closed this as not planned Won't fix, can't repro, duplicate, stale Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation high Required for next release
Projects
None yet
Development

No branches or pull requests

2 participants