ggplot2.utils/README.Rmd at main · insightsengineering/ggplot2.utils · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
---
output: github_document
---
<!-- markdownlint-disable-file -->
<!-- README.md needs to be generated from README.Rmd. Please edit that file -->

# ggplot2.utils <a href="https://insightsengineering.github.io/ggplot2.utils/"><img src="man/figures/logo.svg" align="right" height="139" /></a>

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
```

<!-- 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/ggplot2.utils)](https://www.r-pkg.org/badges/version-last-release/ggplot2.utils)
[![CRAN monthly downloads](https://cranlogs.r-pkg.org/badges/ggplot2.utils)](https://cranlogs.r-pkg.org/badges/ggplot2.utils)
[![CRAN total downloads](https://cranlogs.r-pkg.org/badges/grand-total/ggplot2.utils)](https://cranlogs.r-pkg.org/badges/grand-total/ggplot2.utils)
[![Code Coverage](https://raw.githubusercontent.com/insightsengineering/ggplot2.utils/_xml_coverage_reports/data/main/badge.svg)](https://raw.githubusercontent.com/insightsengineering/ggplot2.utils/_xml_coverage_reports/data/main/coverage.xml)
<!-- badges: end -->
\

The `ggplot2.utils` package simplifies access to utility functions adding functionality to [ggplot2](https://ggplot2.tidyverse.org/). The package imports functions across multiple extensions packages and then exports them, so that the user only needs to load this package instead of multiple others.
In addition, this package provides layers for Kaplan-Meier lines and ticks additions to plots.
All functions are tested to make sure that they work reliably.

## Installation

Typically you want to install the release version. Developers and beta-testers
might want to install the development version.

### Release

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

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

### Development

You can install the current development version from *R-Universe* with:

```{r runiverse-installation, eval = FALSE}
install.packages(
  "ggplot2.utils",
  repos = c("https://insightsengineering.r-universe.dev", "https://cloud.r-project.org")
)
```

Alternatively, you can install the current development version from *GitHub* with:

```{r gh-installation, eval = FALSE}
if (!require("remotes")) {
  install.packages("remotes")
}
remotes::install_github("insightsengineering/ggplot2.utils")
```

## Getting Started

Have a look at the package index to explore the available functionality:

```{r index, eval = FALSE}
help(package = "ggplot2.utils")
```

## Citing `ggplot2.utils`

To cite `ggplot2.utils` please see [here](https://insightsengineering.github.io/ggplot2.utils/latest-tag/authors.html#citation).