-
Notifications
You must be signed in to change notification settings - Fork 3
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
Update DESCRIPTION #77
Conversation
@dgrassellyb thanks for this! do you want to add a brief 1 liner to the NEWS.md file for this and the other PR earlier updating the default CI workflows? its a bit of a nice to have for something like this template repo as people would always just take the latest, but can't harm to call out what has changed over time. |
Sure ! I guess we can stay bit high level (the main change actually concerns the fact we get rid of |
agree @dgrassellyb - if you can add something brief then i'll approve and merge. |
done ! I also deleted renv releated conf because we're not using |
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 @dgrassellyb!
@bms63 @manciniedoardo do you want to sanity check anything here before we merge?
NEWS.md
Outdated
@@ -4,6 +4,11 @@ | |||
|
|||
- Package Extension guidance on the front page was updated and moved to [this location](https://pharmaverse.github.io/admiraldev/main/articles/package_extensions.html) in `{admiraldev}`, and a link was added to point to the new location (#61). |
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.
This link doesn't work for me, but [this one does].
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.
I don't know much about what you want to refer from admiraldev here exactly, maybe we can just copy paste what we have from admiral readme ?
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.
(@rossfarrugia / @manciniedoardo : also just fixed the templates - we were using old admiral.test
=> I updated news.md as well on this
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.
good spot for admiral.test! i think the admiraldev reference is fine for now
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.
oh sorry missed the broken link comment - @dgrassellyb you just need to remove the main/
bit in that link and it works then
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.
I fixed them on readme.Rmd
but we will see the updates on readme.Rmd
only when we will merge to main branch
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.
@bms63 @manciniedoardo didn't we get rid of the README.Rmd
approach now and we only use README.md
? sorry, every boulder we turn over seems to find a new surprise here, as we've updated so much in admiral conventions since the last time we made a new pkg ext.
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.
admiral never had a .Rmd
it was adopted into the other extension packages and admiraldev right about when I came onbaord. Honestly, I'd like to get rid of them all - I think we had them for helping with dynamic linking but can't remember anymore??
Anyways, I think we should remove here and remove in peds
as well and maybe make a push for removing them in all packages??
Try to keep as simple as possible!
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.
just deleted it, I think as well it's a bit overkill honestly - for vbump
I commented it to not use it for admiraltemplates
directly, but still keep it because some other projects might want to use it
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.
i just removed the readme rendering from admiralpeds too
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.
Just a note about a broken link.
I was thinking on the vbump stuff - do we want to use it in a template package. This is never going to be released. - we are always going to be in dev mode. Also I removed the renv stuff in another PR |
I moved the DESCRIPTION and news back to 0.0.3. Let's merge this in and make other updates as needed. Exciting to have the template caught up to current standards. Nothing like a deadline to make frantic last minute updates!! :) |
Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.
Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the
devel
branch until you have checked off each task.styler::style_file()
to style R and Rmd filesdevtools::document()
so all.Rd
files in theman
folder and theNAMESPACE
file in the project root are updated appropriatelyNEWS.md
if the changes pertain to a user-facing function (i.e. it has an@export
tag) or documentation aimed at users (rather than developers)pkgdown::build_site()
and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.lintr::lint_package()
R CMD check
locally and address all errors and warnings -devtools::check()