From 83706fb66386e67b3507566a2e1de9768a4674a4 Mon Sep 17 00:00:00 2001 From: Richard Hanna Date: Mon, 30 Oct 2023 16:13:37 -0400 Subject: [PATCH] Update WORDLIST :pencil: --- README.Rmd | 2 +- README.md | 4 ++-- inst/WORDLIST | 4 +++- vignettes/articles/add_arrows.Rmd | 2 +- 4 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.Rmd b/README.Rmd index 69d45bb..3b719dd 100644 --- a/README.Rmd +++ b/README.Rmd @@ -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! diff --git a/README.md b/README.md index eec6861..22a51ba 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/inst/WORDLIST b/inst/WORDLIST index 92424dc..442244e 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -5,12 +5,14 @@ Lifecycle README arg args +callouts cli colour ggcuminc ggplot ggswim's +ggswim’s pre tibble tibbles -️ +unicode diff --git a/vignettes/articles/add_arrows.Rmd b/vignettes/articles/add_arrows.Rmd index b8a5bcc..f38981f 100644 --- a/vignettes/articles/add_arrows.Rmd +++ b/vignettes/articles/add_arrows.Rmd @@ -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).