Skip to content

Commit

Permalink
Update WORDLIST 📝
Browse files Browse the repository at this point in the history
  • Loading branch information
rsh52 committed Oct 30, 2023
1 parent 9963202 commit 83706fb
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Let's dive right into a quick example to showcase the simplicity and effectivene
To help you get started, ggswim includes a sample dataset named `patient_status`. This dataset comprises three tibbles:

- `patient_status`: Designed for ease of use with ggswim, it may not perfectly mirror real-world data, but serves as an ideal starting point. A 7 column tibble with subject cohorts, statuses, and start and end times.
- `adverse_events`: A 3 column tibble showcasing 3 kinds of AEs and the time when they occurred
- `adverse_events`: A 3 column tibble showcasing 3 kinds of adverse events and the time when they occurred
- `medication_administration`: A 4 column tibble showcasing 2 kinds of medications and the time they were given

You can also access each of these tibbles individually. Let's load the data and dive into creating our swimmer plots!
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ To help you get started, ggswim includes a sample dataset named
perfectly mirror real-world data, but serves as an ideal starting
point. A 7 column tibble with subject cohorts, statuses, and start and
end times.
- `adverse_events`: A 3 column tibble showcasing 3 kinds of AEs and the
time when they occurred
- `adverse_events`: A 3 column tibble showcasing 3 kinds of adverse
events and the time when they occurred
- `medication_administration`: A 4 column tibble showcasing 2 kinds of
medications and the time they were given

Expand Down
4 changes: 3 additions & 1 deletion inst/WORDLIST
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ Lifecycle
README
arg
args
callouts
cli
colour
ggcuminc
ggplot
ggswim's
ggswim’s
pre
tibble
tibbles
unicode
2 changes: 1 addition & 1 deletion vignettes/articles/add_arrows.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ knitr::opts_chunk$set(
library(ggswim)
```

In certain scenarios, it can be userful to visually indicate the continuation of specific records in a swimmer plot. This is where the optional feature of adding arrows to the tail ends of swimmer plot lanes in ggswim comes in handy. Example use cases include illustrating the ongoing care of patients or highlighting record "survival" statuses.
In certain scenarios, it can be useful to visually indicate the continuation of specific records in a swimmer plot. This is where the optional feature of adding arrows to the tail ends of swimmer plot lanes in ggswim comes in handy. Example use cases include illustrating the ongoing care of patients or highlighting record "survival" statuses.

Behind the scenes, the inclusion of arrows is facilitated by a call to `ggplot2::geom_segment()`, coupled with some fine-tuning. While the segments themselves have zero length, the arrows are made possible with a defined length parameter. Within `ggswim()`, users have full control over this length, along with options for color, fill, and type (refer to `?ggswim` for detailed information).

Expand Down

0 comments on commit 83706fb

Please sign in to comment.