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

update readme #328

Merged
merged 1 commit into from
Aug 28, 2024
Merged
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
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,28 +40,21 @@ This package provides:
## Installation

```r
# stable versions
install.packages('teal.data')

# install.packages("pak")
pak::pak("insightsengineering/teal.data@*release")
```

Alternatively, you might want to use the development version available on [r-universe](https://r-universe.dev/).
Alternatively, you might want to use the development version.

```r
# beta versions
install.packages('teal.data', repos = c('https://pharmaverse.r-universe.dev', getOption('repos')))

# install.packages("pak")
pak::pak("insightsengineering/teal.data")
```

## Usage

To understand how to use this package, please refer to the [Introduction to teal.data](https://insightsengineering.github.io/teal.data/latest-tag/articles/teal-data.html) article, which provides multiple examples of code implementation.
To understand how to use this package, please refer to the [Introduction to `teal.data`](https://insightsengineering.github.io/teal.data/latest-tag/articles/teal-data.html) article, which provides multiple examples of code implementation.

Below is the showcase of the example usage
Below is the showcase of the example usage.

```r
library(teal.data)
Expand All @@ -78,7 +71,7 @@ my_data <- cdisc_data(
})
)

# or
# or

my_data <- within(teal_data(), {
ADSL <- example_cdisc_data("ADSL")
Expand Down
Loading