Merge pull request #670 from The-Strategy-Unit/647-bump-v5

Bump version 5, improve docs

Author: matt-dray

.Renviron.example

@@ -12,3 +12,7 @@ NHP_ENCRYPT_KEY=
 NHP_OUTPUTS_URI=https://connect.strategyunitwm.nhs.uk/nhp/{version}/outputs/
 CACHE_VERSION=
 FEEDBACK_FORM_URL=
+YEAR_HORIZON_DEFAULT=2041
+YEAR_HORIZON_MAX=2043
+YEAR_BASELINE_DEFAULT=2024
+YEAR_BASELINE_MIN=2023

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: inputs
 Title: NHP Model Inputs
-Version: 4.4.1
+Version: 5.0.0
 Authors@R: c(
     person("Tom", "Jemmett", , "thomas.jemmett@nhs.net", role = c("cre", "aut")),
     person("Matt", "Dray", , "matt.dray@nhs.net", role = "aut"),

README.Rmd

@@ -40,16 +40,20 @@ The app is built and maintained by members of [the Strategy Unit's Data Science
 Technically there are two apps: the main app in the `main` branch, and the inputs selection app (where users start or edit a scenario) in the `inputs_selection_app` branch.
 Users arrive at the selection app before being routed to the main app. 
 
-Both apps are built with [Shiny](https://shiny.posit.co/) and the main app uses the [the {golem} package](https://thinkr-open.github.io/golem/). Server and UI modules can be found in `R/`, configuration in `inst/golem-config.yml` and supporting data and text in `inst/app/`.
-
-Packages used in the app are listed in `DESCRIPTION`, and can be installed with `devtools::install_deps(dependencies = TRUE)`.
+Both apps are built with [Shiny](https://shiny.posit.co/) and the main app uses the [the {golem} package](https://thinkr-open.github.io/golem/).
+Server and UI modules can be found in `R/`, configuration in `inst/golem-config.yml` and supporting data and text in `inst/app/`.
 
 ### Run locally
 
 Run the app locally on your machine to test that your changes work as expected.
 
-To prepare, add an `.Renviron` file to the project root that contains the required environment variables. There is an `.Renviron.example` file which describes the required variables.
-You can get these from a member of the Data Science team.
+#### Setup
+
+First, install the required packages listed in the DESCRIPTION with `pak::local_install_deps(dependencies = TRUE)`.
+
+Then add an `.Renviron` file to the project root that contains the required environment variables.
+Copy into it the required variables, which are listed in the `.Renviron.example`.
+You can get the values you need from a member of the Data Science team.
 
 Then, from the `main` branch (or your development branch of it), use Git's `worktree` function to put the `inputs_selection_app` branch (or your development branch of it) in its own subfolder. 
 
@@ -60,21 +64,35 @@ git fetch origin inputs_selection_app
 git worktree add inputs_selection_app inputs_selection_app
 ```
 
+The first argument is the name of the folder in which to put the branch content.
 If you want a development version of the inputs selection app, you can specify the branch name as the second of the arguments to `git worktree add`.
 
-To run the app from RStudio, start up the selection app by opening the `dev/watch.R` script, go to the 'Background Jobs' tab of the console pane and click the 'Start Background Job' button.
-In the 'Run Script as Background Job' dialog box select the project root as the 'Working Directory', then hit 'Start'.
-When ready, the app will tell you to visit `http://127.0.0.1:9081/` in your browser.
-
-Note that your selections in the app remain local to you and the resulting json file of parameters for your scenario will live in your local `params/development/` directory.
-These scenarios will be selectable and editable in future from your locally-run inputs selection app.
-
 If you need to remove the selection-app folder at any point, you can terminate the background job (if running) and in the terminal run:
 
 ```
 git worktree remove inputs_selection_app
 ```
 
+#### Run the app
+
+Once setup, we can run the app.
+This is done by launching a background Shiny app and then watching the files for changes, which causes an auto-reload.
+The method for doing this depends on your IDE.
+
+In RStudio:
+
+1. Open the `dev/watch.R` script and go to the 'Background Jobs' tab of the console pane and click the 'Start Background Job' button.
+2. Click 'Start' after checking that the 'R Script' path is pre-populated with the path to `watch.R` (otherwise select it yourself). 
+3. When ready, a message will tell you to visit `http://127.0.0.1:9081/` in your browser.
+
+In Positron: run `source('dev/watch.R')` and click the link to the URL when complete.
+
+In VS Code: open the command palette (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>), search for 'Tasks: Run Task', then select 'R: Run App (watch)' and finally click the link to the URL when complete.
+
+Making selections in the app will cause values to be written to a local json file, which will live in your local `params/development/` directory.
+These scenarios will be selectable and editable in future from your locally-run inputs selection app.
+They will not be available from the deployed app.
+
 ### Test in dev
 
 During pre-release QA we test both apps on the server.
@@ -84,7 +102,7 @@ To test the unreleased app in our development environment:
 
 1. Merge any PRs you want to test into the `main` branch.
 2. If you've changed any dependencies, run `dev/generate_manifest.R` to update `manifest.json`.
-3. If you've made any changes to the inputs selection app, run the manual `deploy()` call under the 'development' heading in the `deploy.R` script in your selection app development branch.
+3. If you've made any changes to the inputs selection app, run the manual `deploy()` call under the 'development' heading in the `deploy.R` script in your selection-app development branch.
 
 When using the dev inputs selection app on Connect, make sure to set the 'Model Version' dropdown to 'dev' in the expandable 'Advanced Options' box.
 That way you'll be taken to the dev inputs app when you hit 'Start'.