Skip to content

Commit 319c9b5

Browse files
Give more details what's going on 'Under the hood'
1 parent f947d78 commit 319c9b5

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

OVERVIEW.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,11 @@ For a more up-to-date view on what features might be added, see <https://github.
127127

128128
### Under the hood
129129

130+
When using the **progressr** package, progression updates are communicated via R's condition framework, which provides methods for creating, signaling, capturing, muffling, and relaying conditions. Progression updates are of classes `progression` and `immediateCondition`(\*). The below figure gives an example how progression conditions are created, signaled, and rendered.
131+
132+
(\*) The `immediateCondition` class of conditions are relayed as soon as possible by the [**future**](https://cran.r-project.org/package=future) framework, which means that progression updates produced in parallel workers are reported to the end user as soon as the main R session have received them.
133+
134+
130135

131136

132137
![](vignettes/figures/slow_sum.svg)

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,17 @@ For a more up-to-date view on what features might be added, see <https://github.
129129

130130
### Under the hood
131131

132+
When using the **progressr** package, progression updates are communicated via R's condition framework, which provides methods for creating, signaling, capturing, muffling, and relaying conditions. Progression updates are of classes `progression` and `immediateCondition`(\*). The below figure gives an example how progression conditions are created, signaled, and rendered.
133+
134+
(\*) The `immediateCondition` class of conditions are relayed as soon as possible by the [**future**](https://cran.r-project.org/package=future) framework, which means that progression updates produced in parallel workers are reported to the end user as soon as the main R session have received them.
135+
136+
137+
138+
132139
![](vignettes/figures/slow_sum.svg)
133140

141+
_Figure: Sequence diagram illustrating how signaled progression conditions are captured by `with_progress()` and relayed to the two progression handlers 'progress' (a progress bar in the terminal) and 'beepr' (auditory) that the end user has choosen._
142+
134143

135144
### Debugging
136145

0 commit comments

Comments
 (0)