File: progress_aggregator.Rd

package info (click to toggle)
r-cran-progressr 0.15.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,132 kB
  • sloc: sh: 13; makefile: 7
file content (34 lines) | stat: -rw-r--r-- 734 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/progress_aggregator.R
\name{progress_aggregator}
\alias{progress_aggregator}
\title{Aggregate Progression Conditions}
\usage{
progress_aggregator(progress)
}
\arguments{
\item{progress}{A \link{progressor} function.}
}
\value{
A function of class \code{progress_aggregator}.
}
\description{
Aggregate Progression Conditions
}
\examples{
library(progressr)

message("progress_aggregator() ...")

with_progress({
  progress <- progressor(steps = 4L)
  relay_progress <- progress_aggregator(progress)
  progress()
  relay_progress(slow_sum(1:3))
  relay_progress(slow_sum(1:10))
  progress()
})

message("progress_aggregator() ... done")
}
\keyword{internal}