futureverse / futureverse/progressify

`fwb` transpiler: progress bar is one tick short when `simple = TRUE`

Aperta
#3 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
R
Stelle
4
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

The `fwb` transpiler's skip count assumes `fwb()` calls `statistic` on unit weights
**twice** when `simple = TRUE`. In the current *fwb* development version it calls it once,
whatever `simple` is, so the wrapper swallows the first real bootstrap replicate's update
and the bar finishes one tick short of `R`. This might cause an issue once the development version is on CRAN, so I wanted to let you know before I submitted it.

`template_fwb_outer` sets:

```r
.progressr_skip_count <- if (.progressr_simple) 2L else 1L
```

and `template_fwb_FUN` decrements that on each call before it starts ticking. The count is
the number of times `fwb()` calls `statistic` before the `R` replicates begin.

In *fwb* 0.6.0 and earlier, `simple = TRUE` did call `statistic` twice on unit weights: the
second call existed only to detect whether `statistic` had a random component, which
determined whether the bootstrap weights could later be recovered. The development version
recovers the weights from recorded RNG streams instead, so that detection became
unnecessary and the second call was removed. There is now exactly one unit-weight call in
both cases.

An unconditional

```r
.progressr_skip_count <- 1L
```

is correct for the development version and for every release after it.

It would break *fwb* 0.6.0, though: `simple = TRUE` there would leave the second
unit-weight call to be counted as a tick, giving `R + 1` updates against a progressor with
`R` steps. So if you want to keep 0.6.0 working, this needs a version test:

```r
.progressr_skip_count <- if (.progressr_simple &&
utils::packageVersion("fwb") <= "0.6.0") 2L else 1L
```

Note that an unconditional skip count also removes the need to infer `simple`,
which the template currently does by reproducing `fwb()`'s default rule:

```r
.progressr_simple <- if (is.null(SIMPLE)) WTYPE != "multinom" else SIMPLE
```

With a constant skip count, `SIMPLE` and `WTYPE` are not needed at all.

### Related, separate: `R` is not always the number of replicates

Worth flagging while you're in this code, since it also makes `.progressr_steps` wrong.

The development version adds an exhaustive multinomial bootstrap: because there are only
`n^n` distinct multinomial resamples of `n` units, when `R` reaches that many `fwb()` uses
each exactly once and **reduces `R`** to that number. The transpiler takes `steps` from the
`R` in the call, so the bar stalls partway.

Only reachable for very small `n` (`n = 6` already has 46656 resamples, so with the default
`R = 999` nothing above `n = 4` is affected), and `fwb()` emits a message saying it has done
this. There may be nothing worth doing about it since the number of replicates isn't knowable
from the call alone, so a transpiler arguably cannot get this right in general. Recording it
rather than proposing a fix. Sorry to add this complication.

(Note: I used Claude Code to help with these edits and this issue.)

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inspect the generated code in template_fwb_outer and template_fwb_FUN, starting with how .progressr_skip_count is set and decremented around fwb()'s statistic calls. Verify the progress updates against the development version and fwb 0.6.0, including the version-dependent behavior; done means the first replicate is not swallowed and supported versions produce exactly R updates where the replicate count is knowable.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
r
Ambito
developer-experience, tooling
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Attiva
Chiarezza
Abbastanza chiara
Idoneità per principianti
68/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.