Skip to content

Commit

Permalink
Vignette
Browse files Browse the repository at this point in the history
  • Loading branch information
wlandau-lilly committed Sep 20, 2023
1 parent 9e83bde commit dcae48c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
4 changes: 1 addition & 3 deletions tests/testthat/test-crew_launcher.R
Original file line number Diff line number Diff line change
Expand Up @@ -363,8 +363,6 @@ crew_test("custom launcher", {
walk(x = controller$launcher$done(), f = controller$launcher$rotate)
controller$launcher$tally()
out <- controller$launcher$summary()
for (field in c("worker", "launches", "assigned", "complete")) {
expect_equal(out[[field]], 1L)
}
expect_equal(out$launches, 1L)
controller$terminate()
})
12 changes: 6 additions & 6 deletions vignettes/introduction.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -159,15 +159,15 @@ controller$schedule$summary()
#> 1 0 0
```

The launcher summary counts the number of times each worker was launched, and it shows the total number of assigned and completed tasks from all past terminated instances of each worker.
The launcher summary counts the number of times each worker was launched, and it shows the total number of assigned and completed tasks from all past terminated instances of each worker. In addition, it shows whether the current worker instance was actively connected ("online") or had connected at some point during its life cycle ("discovered") as of the last call to `controller$launcher$tally()`.

```{r}
controller$launcher$summary()
#> # A tibble: 2 × 4
#> worker launches assigned complete
#> <int> <int> <int> <int>
#> 1 1 2 1 1
#> 2 2 1 0 0
#> # A tibble: 2 × 6
#> worker launches online discovered assigned complete
#> <int> <int> <lgl> <lgl> <int> <int>
#> 1 1 2 TRUE TRUE 0 0
#> 2 2 1 TRUE TRUE 0 0
```

Finally, the client summary shows up-to-date worker status from `mirai::daemons()`.
Expand Down

0 comments on commit dcae48c

Please sign in to comment.