commit: Commit a change to a tracked environment.

Description Usage Arguments See Also Examples

Description

Committing a change is equivalent to storing a patch object (see objectdiff). For the moment, any comment will produce a single patch by "squishing" any changes made to the environment. If you are iterating over an environment object many many times, you should probably batch changes if it lives in a tracked environment. Otherwise, for example, making 1,000,000 small modifications to a data.frame before commiting could cause a long time to recompute the "final patch".

Usage

1
2
3
4
## S3 replacement method for class 'tracked_environment'
commit(env) <- value

commit(env, value = NULL)

Arguments

env

tracked_environment.

value

character. Commit message. May be NULL.

See Also

objectdiff)

Examples

1
2
3
4
x <- tracked_environment()
x$foo <- 1
commit(x) <- 'First message'
x$foo <- 2

robertzk/objectdiff documentation built on May 27, 2019, 10:35 a.m.