New Template in RStudio's New Project Wizard #128
Conversation
howardbaik
requested review from
avahoffman,
carriewright11,
cansavvy,
kweav and
ehumph
There was a problem hiding this comment.
@howardbaek I'm really glad you pursued this idea of yours. This is gonna be great. I think there's a solid foundation of code here and now we just have to address some further development of how this should be implemented.
Take a look at these comments and questions and happy to chat about them more in a meeting if that would be helpful!
| @@ -0,0 +1,25 @@ | |||
| name: Delete Preview | |||
There was a problem hiding this comment.
This is going to create a bit of a maintenance problem for when these files are updated in the main template.
There's two solutions I can think of to help.
- Have the function download the files directly from the main OTTR repo: https://github.com/jhudsl/OTTR_Template/
- We can have it so the sync file syncs to this R package.
The only reason I find 2 slightly less good of a solution is that this means in order for people to get the updates we would have to update to CRAN and the user would have to update to the most recent ottrpal package version.
Whereas alternatively 1 will make sure people have the latest no matter the ottrpal package version.
There was a problem hiding this comment.
I don't think there will be many updates to the main template and even if we do make any updates, users can fetch the updates by downloading the development version of ottrpal from GitHub.
The main template is https://github.com/fhdsl/ottr. It is not https://github.com/jhudsl/OTTR_Template/, since this function setups up the Quarto-based OTTR template, not the Rmd-based OTTR Template.
There was a problem hiding this comment.
There will definitely be more updates to OTTR in the future. We should also probably have this try to work for both Rmds and Quarto if possible (but I know that's another lift).
Some of the files you are having it download are GHA which will definitely change because people's GHA that we are using deprecate overtime. I think downloading the files directly will be a more stable move but we can definitely brainstorm on this.
There was a problem hiding this comment.
We can do one step at a time. (no need to worry about this in this PR) But we will want to make maintenance a tad easier. Happy to talk more at length.
To reiterate I am VERY excited about the work you are doing here -- was not something even on my radar. So you should definitely give yourself a pat on the back for this work!
But we will have to figure out some details like maintenance, but I'm happy to help with this.
There was a problem hiding this comment.
Yeah I'll setup a meeting with you to talk about this further.
…-Based OTTR Course"
Purpose/implementation Section
What changes are being implemented in this Pull Request?
Following this article on RStudio Project Templates, I added a Project Template to the RStudio "New Project" Wizard, as seen below:
What was your approach?
setup_project()is the "template function" that RStudio will invoke to instantiate a Quarto course template inside a freshly opened RStudio Session. It creates a directory in the path, copies all the boilerplate files into the path, and importantly, specifies the course title, course author, and repo URL in the_quarto.yml.rstudio_project_template.dcfdefines the user inputs in the RStudio "New Project Wizard".inst/style-sets/files are boilerplate files included in Quarto-Based OTTR.I've included 4 options for Style sets: FHDaSL, AnVIL, GDSCN, Custom. When user selects "Custom", they need to upload an image file of their
logo.png, which will be placed in the left sidebar. All the other style sets include the respective logos and favicons.What GitHub issue does your pull request address?
#127
Tell potential reviewers what kind of feedback you are soliciting.
What CSS elements am I missing in the 3 predefined style sets: FHDaSL, AnVIL, GDSCN?