Skip to content

Commit 31e62fb

Browse files
committed
Merge branch 'release/0.1.3'
2 parents fae16fb + 99a726c commit 31e62fb

File tree

4 files changed

+10
-7
lines changed

4 files changed

+10
-7
lines changed

CITATION.cff

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ identifiers:
6060
- type: doi
6161
value: 10.5281/zenodo.15837864
6262
license: Apache-2.0
63-
version: 0.1.2
64-
date-released: '2025-07-09'
63+
version: 0.1.3
64+
date-released: '2025-11-03'

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Package: participantFlowDiagram
22
Type: Package
33
Title: Graphically shows the progress of research participants through a study protocol
4-
Version: 0.1.2
4+
Version: 0.1.3
55
Authors@R: c(
66
person("Philip", "Chase",
77
email = "pbc@ufl.edu",

NEWS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# participantFlowDiagram 0.1.3 (released 2025-11-03)
2+
- Fix grammar and update wording in Getting-Started.Rmd (@pbchase)
3+
14
# participantFlowDiagram 0.1.2 (released 2025-07-09)
25
- Fix label in example diagram and table (@pbchase)
36
- Fix reference to gtsummary::tbl_summary() (@pbchase)

vignettes/articles/Getting-Started.Rmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,8 @@ create_table(
9898

9999
Using `participantFlowDiagram` requires a detailed dataset, `participant_level_progress`, that documents each step in the workflow. The dataset has multiple constraints:
100100

101-
- Each column must be as a factor. Each level in the factor is a possible state at that step.
102-
- Each factor should define all possible levels at that step. This in includes an unknown level to be set when no other logic at that level is true.
101+
- Each column must be a factor. Each level in the factor is a possible state at that step.
102+
- Each factor should define all possible levels at that step. This should include an "unknown" level to be set when no other logic at that level is true.
103103
- Each factor value needs to be unique across all the factors because the factor values will be nodes names in a diagram. It is easy to manage this by prefixing each factor level with the column name.
104104
- The steps should appear in the order of the workflow as this order governs the order in the table. While not required, this will improve the readability of the summary table.
105105
- At each step, the count of non-null values should equal the count for the parent node.
@@ -119,7 +119,7 @@ The second required dataset is a small, two-column dataset that names the parent
119119
steps
120120
```
121121

122-
A third dataset, `pretty_labels`, can be generated with the package function `get_pretty_labels_template()`
122+
A third dataset, `pretty_labels`, should be generated with the package function `get_pretty_labels_template()`
123123

124124
```{r describe-pretty-labels}
125125
pretty_labels_template <- get_pretty_labels_template(
@@ -170,7 +170,7 @@ diagram
170170
```
171171

172172

173-
To get control of the labels, save the output of `get_pretty_labels_template()` and edit the `pretty_label` column. You can write tribble code using `timesaveR::to_tribble()` to write tribble code and paste that inline in your code. `get_pretty_labels_template()` uses the same value as `plain_label` in `pretty_label`. Edit the `pretty_label` column as needed.
173+
To get control of the labels, save the output of `get_pretty_labels_template()` and edit the `pretty_label` column. The easiest path is to use `timesaveR::to_tribble()` to write tribble code and paste that inline in your code. `get_pretty_labels_template()` uses the same value as `plain_label` in `pretty_label`. Edit the `pretty_label` column as needed get the labels you'd like to see on the nodes.
174174

175175
Use `\n` to get new line characters to wrap the text of the pretty labels in the diagram. These newline codes will be ignored in the table.
176176

0 commit comments

Comments
 (0)