diff --git a/README.md b/README.md index 119259b..c83ce71 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,7 @@ R package containing preferred methods for creating official DfE R-Shiny dashboa # Contributing -** Try and make use of the `usethis` package wherever relevant: (https://usethis.r-lib.org/)[https://usethis.r-lib.org/]. - +Try and make use of the [usethis](https://usethis.r-lib.org/) package wherever possible. ## Adding a package/dependency @@ -12,7 +11,6 @@ R package containing preferred methods for creating official DfE R-Shiny dashboa This will create a new script within the package R/ folder. - ## Creating a new script `usethis::use_r(name = )` @@ -29,4 +27,11 @@ can increment the package version using: Once you've incremented the version number, it'll offer to perform a commit on your behalf, so all you then need to do is push to GitHub. # Installing the package -To install, run `renv::install("git::https://github.com/dfe-analytical-services/dfeshiny")` +To install, run `renv::install("dfe-analytical-services/dfeshiny")`. + +## Potential errors when installing +If you get `ERROR [curl: (22) The requested URL returned error: 401]`, and don't know why, try running `Sys.unsetenv("GITHUB_PAT")` to temporarily clear your GitHub PAT variable. + +Then try to install again. + +If this works, then you will need to look for where that "GITHUB_PAT" variable is being set from and remove it to permanently fix the issue, contact us for support if you need help with this or have any other issues installing.