RConsortium/submissions-pilot2

The purpose of `dev` folder

fb-elong opened this issue · 2 comments

fb-elong commented

Could we clarify the purpose of dev folder? Should it be either removed or move into the inst folder?

https://github.com/RConsortium/submissions-pilot2/tree/main/dev

rpodcast commented

The dev folder is a part of the development workflow with using {golem} to author a Shiny app. My biggest reason for keeping the directory is the script dev/run_dev.R is used to run the application in a local development mode, which respects the configuration option for the data set file system location set within inst/golem-config.yml.

My original plan was to install the application package itself pilot2wrappers into the {renv} package library, such that the reviewer could simply call pilot2wrappers::run_app() from the console after making their data path config update. However, that does not work because when the app is executed from that (built) version of the app, the config for the data path will not be automatically updated. Hence I decided to keep the dev folder within the repo and simply let the user run the app by either executing the contents of app.R or running golem:::run_dev() in the R console.

fb-elong commented

Thanks for the clarification. Would be great to have the information in the README file to explain the purpose of each folder for future reference.