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

Question: should we add references in vignettes? #73

Closed
tomaszaba opened this issue Nov 4, 2024 · 3 comments
Closed

Question: should we add references in vignettes? #73

tomaszaba opened this issue Nov 4, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@tomaszaba
Copy link
Collaborator

In some functions we make a reference to resources used. I was wondering if we need do the same in vignettes, particularly the ones about IPC checks and plausibility checks?

@tomaszaba tomaszaba added documentation Improvements or additions to documentation question Further information is requested labels Nov 4, 2024
@ernestguevarra
Copy link
Member

I think this is a good idea. I think we should. Usually, on CRAN submission, the reviewer always asks for references in the DESCRIPTION file (links only) and references in the function documentation. They don't really read the vignettes in detail but I think it would be good to have references in vignettes

@ernestguevarra ernestguevarra linked a pull request Nov 4, 2024 that will close this issue
@ernestguevarra ernestguevarra removed a link to a pull request Nov 4, 2024
@tomaszaba
Copy link
Collaborator Author

Great. I will work on this when I am done with the prevalence functions.

@tomaszaba
Copy link
Collaborator Author

Done.

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 question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants