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

Function to rename template files to package name and other goodies #80

Open
9 tasks
bms63 opened this issue Jun 3, 2024 · 0 comments
Open
9 tasks

Comments

@bms63
Copy link
Collaborator

bms63 commented Jun 3, 2024

Background

A person who clones the admiraltemplate repo for an extension package has a lot of housecleaning and setup to make it their own. A function should be created that does all the chores for them. For example, make_extension() would update the name of the package in the DESCRIPTION file and other files where either admiraltemplate or admiralext exixts.

Context

This crashes our checks - maybe we could have a startup message that refers to a function that when calls updates everything for the extension pkg? Maybe fun issue for someone to work on from community?

Originally posted by @bms63 in #79 (comment)

Definition of Done

  • Create function that cleans house for an extension package
    • DESCRIPTION files
    • Cleans testthat folder
    • Could place skeleton in readme similar to other admiral packages
    • Renames admiraltemplate.Rproj
    • Renames .Rbuildignore
    • Renames admiraltemplate-package.R
    • Others where needed (creativity is encouraged)
    • Recommendation on resources for creating hex image
      -[ ] Startup Message recommending the function and then on how to remove the Startup message

@pharmaverse/admiral @pharmaverse/admiral_comm Low priority, but a fun one to work on if anyone wants to make a simple "updater" function. It will not get a lot of use, but will make life easier for future extensions. :)

@bms63 bms63 changed the title Function to rename template files to package name Function to rename template files to package name and other goodies Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant