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

Add template for Design Principles vignette #97

Merged
merged 3 commits into from
Nov 15, 2023
Merged

Conversation

joshwlambert
Copy link
Member

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 and DESCRIPTION.

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.

@joshwlambert joshwlambert added the documentation Improvements or additions to documentation label Nov 14, 2023
@joshwlambert
Copy link
Member Author

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?

Copy link
Contributor

@pratikunterwegs pratikunterwegs left a 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.

Copy link
Member

@Bisaloo Bisaloo left a 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!

vignettes/design-principles.Rmd Show resolved Hide resolved
vignettes/design-principles.Rmd Outdated Show resolved Hide resolved
vignettes/design-principles.Rmd Show resolved Hide resolved
joshwlambert and others added 2 commits November 14, 2023 16:29
Co-authored-by: Hugo Gruson <Bisaloo@users.noreply.github.com>
@joshwlambert
Copy link
Member Author

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 _pkgdown.yml). I will not do this in this PR as I think it overcomplicates it for developers that use the template. If someone thinks it is required I can add it in a separate PR.

@joshwlambert joshwlambert merged commit 8279e49 into main Nov 15, 2023
3 checks passed
@joshwlambert joshwlambert deleted the add_design_vig branch November 15, 2023 13:18
Bisaloo added a commit that referenced this pull request Nov 15, 2023
Follow up of #97
Bisaloo added a commit that referenced this pull request Nov 15, 2023
Follow up of #97
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

Successfully merging this pull request may close these issues.

3 participants