Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #18

Merged
merged 2 commits into from
Feb 13, 2024
Merged

Update README.md #18

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4405a63
Update README.md
cjrace Feb 10, 2024
13be437
add potential error note into install section of README
cjrace Feb 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
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.
Loading