UpdateEvery: UpdateEvery

View source: R/updating.R

UpdateEveryR Documentation

UpdateEvery

Description

Sets a period of time, after which an R object is woken and updated.

Usage

UpdateEvery(x, units = "seconds", options = "snapshot")

Arguments

x

The period expressed in units units.

units

The time unit. One of "seconds", "minutes", "hours", "days", "weeks" or "months".

options

Either "wakeup" in which case the object is updated even if its document is closed, or "snapshot" which also updates any embedded snapshots of the document, or "only when open" which only updates when the document is open.

Details

If units = "months", then x must be an integer. The update time will roll back to the last day of the previous month if no such day exists x months forward from today.

See Also

RefreshIfOlderThan, UpdateAt

Examples

UpdateEvery(5, "days", "snapshot")
UpdateEvery(1, "months", NULL)

NumbersInternational/flipTime documentation built on Feb. 26, 2024, 6:44 a.m.