From 95722669d510f4dfe4a9e4ed8e91ba6a6abc9b60 Mon Sep 17 00:00:00 2001 From: Nikolas Burkoff Date: Wed, 6 Jul 2022 13:00:21 +0100 Subject: [PATCH 1/3] update installation instructions --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4202059af..2873ee632 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,10 @@ It is recommended that you [create and use a Github PAT](https://docs.github.com ```r Sys.setenv(GITHUB_PAT = "your_access_token_here") -if (!require("devtools")) install.packages("devtools") -devtools::install_github("insightsengineering/teal.widgets@*release", dependencies = FALSE) +if (!require("remotes")) install.packages("remotes") +remotes::install_github("insightsengineering/teal.widgets@*release") ``` -You might need to manually install all of the package dependencies before installing this package as without -the `dependencies = FALSE` argument to `install_github` it may produce an error. +A stable release of all `NEST` packages is also available [here](https://github.com/insightsengineering/depository#readme). See package vignettes `browseVignettes(package = "teal.widgets")` for usage of this package. From 66922b76c45b6560d343258ced4526fe32769026 Mon Sep 17 00:00:00 2001 From: Nikolas Burkoff Date: Wed, 6 Jul 2022 13:45:29 +0100 Subject: [PATCH 2/3] update --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2873ee632..a408c2798 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This package provides various 'widgets' for `teal` applications. Examples includ ## Installation -It is recommended that you [create and use a Github PAT](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to install the latest version of this package. Once you have the PAT, run the following: +For releases from August 2022 it is recommended that you [create and use a Github PAT](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to install the latest version of this package. Once you have the PAT, run the following: ```r Sys.setenv(GITHUB_PAT = "your_access_token_here") @@ -18,6 +18,6 @@ if (!require("remotes")) install.packages("remotes") remotes::install_github("insightsengineering/teal.widgets@*release") ``` -A stable release of all `NEST` packages is also available [here](https://github.com/insightsengineering/depository#readme). +A stable release of all `NEST` packages from June 2022 is also available [here](https://github.com/insightsengineering/depository#readme). See package vignettes `browseVignettes(package = "teal.widgets")` for usage of this package. From 203843c6ea53a8f9a525f6af1b4efe0adf4cc89a Mon Sep 17 00:00:00 2001 From: Nikolas Burkoff Date: Wed, 6 Jul 2022 13:46:28 +0100 Subject: [PATCH 3/3] spacing --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a408c2798..b216ed51f 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This package provides various 'widgets' for `teal` applications. Examples includ ## Installation -For releases from August 2022 it is recommended that you [create and use a Github PAT](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to install the latest version of this package. Once you have the PAT, run the following: +For releases from August 2022 it is recommended that you [create and use a Github PAT](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to install the latest version of this package. Once you have the PAT, run the following: ```r Sys.setenv(GITHUB_PAT = "your_access_token_here")