-
Notifications
You must be signed in to change notification settings - Fork 7
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 vignettes & update README #27
Conversation
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 tagging me @jamesmbaazam, leaving some general comments here.
Overall looks okay - the vignettes build and the website renders for me - but the main step is to bring this branch up to date with main
- this will need to be done with a rebase as for previous branches. Once that is done this branch will integrate CI checks and should give a better picture what more is needed. Adding a render-readme
workflow might be useful. Locally, R CMD check fails for me with a couple of errors and notes. I've left some comments on the files; happy to take another look or help with the rebase.
- The 'introduction.Rmd' vignette seems to be a repeat of the Readme. Could some more information be added that would make this more useful/comprehensive/not the same?
- Check the website version of the documentation using
pkgdown::build_site()
to check that the articles render in the intended order. If you want to separate the 'bp_literature' article into a separate section that needs to be done in apkgdown.yml
file. - Suggest a {styler} run (including on the vignettes, use
style_dir()
) and then a lint check as well. Also suggest using {goodpractice}.
It's the same because it was moved to the README and is now deleted. |
Thank you for your comments and suggestions. I have now implemented all the changes. |
In this PR,
Introduction.Rmd
vignette to the Quickstart section of READMEcontext()
from tests #34.