Enhance use_vignette_*() #76
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- package-specific vignette template - emphasize overall structure, rather than BiocStyle features - include installation instructions - add arguments to customize output, e.g., `authors=` - README.md contains instructions required to keep in sync with RStudio interactive selection - explicit dependency on 'whisker' package was already implicit - fulfills (partly?) https://community-bioc.slack.com/archives/CLUJWDQF4/p1587422927097500
- requires manual editing on merge to master - helps distinguish installations from this branch from standard installations
|
Hmm, I think I'll revise this a little to augment the original |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request enhances
use_vignette_*()to provide a version of the vignette suitable for use in a package. It emphasizes overall vignette structure (including package installation instructions, reference to the support site, etc) rather than the features offered by markdown or BiocStyle. Functions gain arguments (e.g.,authors = c(person(), person())) for easy production of custom vignettes.It is partly in response to a Bioconductor community developer forum slack post.
The templating infrastructure under
inst/rmarkdown/templates/package_vignetteis a little complicated by the desire to provide a templated version for interactive use, and a complete version for RStudio interactive creation. A README.md file in that directory provides update instructions.