Skip to content

Commit

Permalink
Merge pull request #18 from dfe-analytical-services/update-readme-to-…
Browse files Browse the repository at this point in the history
…original-install

Update README.md
  • Loading branch information
cjrace authored Feb 13, 2024
2 parents 21d1833 + 13be437 commit 136b898
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,14 @@ 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

`usethis::use_package(<package_name>)`

This will create a new script within the package R/ folder.


## Creating a new script

`usethis::use_r(name = <script_name>)`
Expand All @@ -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.

0 comments on commit 136b898

Please sign in to comment.