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

Prevent duplicated runs of examples #25

Open
caitlinch opened this issue Nov 26, 2024 · 1 comment
Open

Prevent duplicated runs of examples #25

caitlinch opened this issue Nov 26, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@caitlinch
Copy link
Collaborator

One of the examples contains the functions getPrevalence(), PoolReg(), PoolRegBayes(), and another 1 or two functions. When running checks during the development process, this example is run multiple times (once for each included function), increasing the time required for the checks process.

Reformat or restructure the example to reduce the run time. One option is to separate out the example into different examples (one per function). The preferred option would be to restructure the manual so all these functions appear on one manual page (and thus the example only runs once) – this option will be easier for the user to understand applying the functions in practice.

@caitlinch caitlinch added the documentation Improvements or additions to documentation label Nov 26, 2024
@caitlinch
Copy link
Collaborator Author

See this vignette on including multiple functions on the same page within the documentation (allowing you to link examples for different functions to a single documentation page).

@caitlinch caitlinch self-assigned this Dec 5, 2024
@caitlinch caitlinch removed their assignment Dec 16, 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
Projects
None yet
Development

No branches or pull requests

1 participant