README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# savvyr <img src="man/figures/logo.png" align="right" width="175" />

<!-- badges: start -->
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![CRAN status](https://www.r-pkg.org/badges/version-last-release/savvyr)](https://www.r-pkg.org/badges/version-last-release/savvyr)
[![CRAN monthly downloads](https://cranlogs.r-pkg.org/badges/savvyr)](https://cranlogs.r-pkg.org/badges/savvyr)
[![CRAN total downloads](https://cranlogs.r-pkg.org/badges/grand-total/savvyr)](https://cranlogs.r-pkg.org/badges/grand-total/savvyr)
[![Code Coverage](https://raw.githubusercontent.com/openpharma/savvyr/_xml_coverage_reports/data/main/badge.svg)](https://raw.githubusercontent.com/openpharma/savvyr/_xml_coverage_reports/data/main/coverage.xml)
<!-- badges: end -->
\

The SAVVY project is a consortium of academic and pharmaceutical
industry partners that aims to improve the analyses of adverse event (AE)
data in clinical trials through the use of survival techniques appropriately
dealing with varying follow-up times and competing events.
Although statistical methodologies have advanced, in AE analyses often
the incidence proportion, the incidence density or a non-parametric
Kaplan-Meier estimator are used, which either ignore censoring or
competing events. The `savvyr` package contains functions to easily conduct the
proposed improved AE analyses.

## Installation

### Release

You can install the current release version from *CRAN* with:

```{r cran-installation, eval = FALSE}
install.packages("savvyr")
```

### Development

You can install the development version of savvyr from [GitHub](https://github.com/) with:

``` r
if (!require("remotes")) {
  install.packages("remotes")
}
remotes::install_github("openpharma/savvyr")
```

## Getting Started

See the [introductory vignette](https://openpharma.github.io/savvyr/main/articles/introduction.html) to get started.

## Citing `savvyr`

To cite `savvyr` please see [here](https://openpharma.github.io/savvyr/main/authors.html#citation).