-
Notifications
You must be signed in to change notification settings - Fork 4
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
Add template for Design Principles vignette #97
Conversation
One thing that came up in discussion around the design vignette was whether suggested dependencies should be included. In the {simulist} vignette they are all listed, however, we agreed it would be best if only uncommon suggested dependencies were mentioned. Some common suggested dependencies are: {knitr}, {rmarkdown}, {ggplot2}, {testthat}. This leads to the question of where to document that we have this list of default package infrastructure suggested dependencies. Would it be useful to add a paragraph to blueprints? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for opening this PR @joshwlambert, looks good to me. We should mention this in today's developer meeting as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I like it! It's comprehensive but flexible and not overwhelming. Good work!
Co-authored-by: Hugo Gruson <Bisaloo@users.noreply.github.com>
One thing I didn't change in this PR which I have done in packages with a design vignette is added a specific header to the vignette drop-down menu on the pkgdown site (by editing |
This PR adds a vignette to the {packagetemplate} which will ensure that each new package generated with this template contains the a design principles vignette. As outlined in the vignette template, the sections are optional and the vignette template is a high-level guide to Epiverse-TRACE package developers.
These changes add package vignette infrastructure to the {packagetemplate} including, additions to the
.gitignore
,vignettes/.gitignore
andDESCRIPTION
.These changes are a result of development to try and get Epiverse-TRACE packages communicating more developer focused decisions, an overview can be found in the Epiverse-TRACE discussions.