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.

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

Add CRAN installation instructions to README #937

Merged
merged 6 commits into from
May 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# tern 0.8.2.9001

### Miscellaneous
* Updated README to include installation instructions for CRAN.

# tern 0.8.2

Expand Down
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,20 @@ Many of these outputs are available to be added into [`teal`](https://insightsen

## Installation

It is recommended that you [create and use a Github PAT](https://docs.github.com/en/authentication/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:
`tern` is available on CRAN and you can install the latest released version with:

```r
install.packages("tern")
```

or you can install the latest development version directly from GitHub by running the following:

```r
Sys.setenv(GITHUB_PAT = "your_access_token_here")
if (!require("remotes")) install.packages("remotes")
remotes::install_github("insightsengineering/tern@*release")
remotes::install_github("insightsengineering/tern")
```

A stable release of all NEST packages from October 2022 is also available [here](https://github.com/insightsengineering/depository#readme).
Note that it is recommended you [create and use a `GITHUB_PAT`](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) if installing from GitHub.

See package vignettes `browseVignettes(package = "tern")` for usage of this package.

Expand Down
2 changes: 1 addition & 1 deletion inst/WORDLIST
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Clopper
Coull
CoxPH
Forkers
Github
Haenszel
Hauck
Hoffmann
Expand All @@ -31,6 +30,7 @@ MedDRA
Murell
Newcombe
Pharmacokinetics
README
Repo
Sabanés
Satterthwaite
Expand Down