Skip to content

Commit

Permalink
update readme (#304)
Browse files Browse the repository at this point in the history
- add links to individual functions
- use `pak` for install instructions
- remove r-universe from install instructions for simplicity
- remove link to the r-universe - this fixes url-checker
  • Loading branch information
pawelru committed Aug 28, 2024
1 parent 8a0968c commit 81de5ae
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,23 @@ This enables `teal` app developers to easily create applications to explore long
## Modules

<!-- markdownlint-disable MD007 MD030 -->
- `tm_g_gh_boxplot`
- `tm_g_gh_correlationplot`
- `tm_g_gh_density_distribution_plot`
- `tm_g_gh_lineplot`
- `tm_g_gh_spaghettiplot`
- [`tm_g_gh_boxplot`](https://insightsengineering.github.io/teal.goshawk/latest-tag/reference/tm_g_gh_boxplot.html)
- [`tm_g_gh_correlationplot`](https://insightsengineering.github.io/teal.goshawk/latest-tag/reference/tm_g_gh_correlationplot.html)
- [`tm_g_gh_density_distribution_plot`](https://insightsengineering.github.io/teal.goshawk/latest-tag/reference/tm_g_gh_density_distribution_plot.html)
- [`tm_g_gh_lineplot`](https://insightsengineering.github.io/teal.goshawk/latest-tag/reference/tm_g_gh_lineplot.html)
- [`tm_g_gh_spaghettiplot`](https://insightsengineering.github.io/teal.goshawk/latest-tag/reference/tm_g_gh_spaghettiplot.html)
<!-- markdownlint-enable MD007 MD030 -->

## Installation

From July 2023 `insightsengineering` packages are available on [r-universe](https://r-universe.dev/).

```r
# stable versions
install.packages('teal.goshawk', repos = c('https://insightsengineering.r-universe.dev', 'https://cloud.r-project.org'))
# install.packages("pak")
pak::pkg_install("insightsengineering/teal.goshawk@*release")

# beta versions
install.packages('teal.goshawk', repos = c('https://pharmaverse.r-universe.dev', 'https://cloud.r-project.org'))
# install.packages("pak")
pak::pkg_install("insightsengineering/teal.goshawk")
```

## Stargazers and Forkers
Expand Down

0 comments on commit 81de5ae

Please sign in to comment.