report_progress: Report Progress of a Process

Description Usage Arguments Value

View source: R/report_progress.R

Description

This function prints out the percent progress in a process given the current iteration the total number of iterations and the percentage at which a progress report is wanted. It only works on loops in which the index is explicitly incremented in the code.

Usage

1
2
3
4
5
6
7
report_progress(
  current,
  total,
  percent_text = 10,
  percent_dot = 2,
  verbose = TRUE
)

Arguments

current

The current index being processed

total

The total number of indices that will be processed

percent_text

The percent progress at which the percent should be printed to the screen.

percent_dot

The percent progress at which a dot should be printed to the screen

verbose

A logical value indicating whether to report progress to the screen. Defaults to TRUE.

Value

None. Prints output to the screen.


cape documentation built on Feb. 10, 2021, 5:06 p.m.