You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: vignettes/articles/Getting-Started.Rmd
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -98,8 +98,8 @@ create_table(
98
98
99
99
Using `participantFlowDiagram` requires a detailed dataset, `participant_level_progress`, that documents each step in the workflow. The dataset has multiple constraints:
100
100
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.
103
103
- 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.
104
104
- 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.
105
105
- 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
119
119
steps
120
120
```
121
121
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()`
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.
174
174
175
175
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.
0 commit comments