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

Consider adding a PoolPoweR-package.R file? #18

Open
AngusMcLure opened this issue Nov 24, 2023 · 1 comment
Open

Consider adding a PoolPoweR-package.R file? #18

AngusMcLure opened this issue Nov 24, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@AngusMcLure
Copy link
Owner

I think that is standard to have a package_name-package.R file in the R folder of the package. This just contains some roxygen-style comments at the top which then get compiled to do various things across the documentation. For the PoolTestR I've used one to do a bunch of things including put in possible references and description. Now, I can't quite recall exactly why this file is needed, but I think it might be or is at least recommended. Could you look into it please, Fred? I think the resource I'd look at is Hadley's book on R packages

@AngusMcLure AngusMcLure added the documentation Improvements or additions to documentation label Nov 24, 2023
@fredjaya
Copy link
Collaborator

Sure thing, i'll look into it

@fredjaya fredjaya added this to the v0.0.3 milestone Nov 24, 2023
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

2 participants