internal_object_store: Manage object stores.

Description Usage Arguments Value

Description

Manage object stores.

discover_object_store starts with with given path and searches for a configuration file (not implemented yet) or an existing object store that experiment can use for the current R session. If a store can be found, an storage::object_store object is returned; otherwise, a NULL value is returned.

prepare_object_store opens an existing object store (via discover_object_store) or creates a new, temporary one.

create_stash creates an empty object store under the given path.

reattach_to_store makes store the current object store and determines which commit present in that store should become the current parent commit (in git known as HEAD). It is used only in tracking_on but it is separate from it for testing purposes.

Usage

1
2
3
4
5
6
7
8
discover_object_store(path = getwd())

prepare_object_store(path, .silent = !interactive())

create_stash(path = file.path(tempdir(), "experiment-stash"))

reattach_to_store(state, store, env, .global = "abort",
  .silent = !interactive())

Arguments

path

Path to be examined.

.silent

Reduce the verbosity to warnings and errors.

state

The internal_state object or a testing mock object.

store

A storage::object_store object.

env

The globalenv or testing mock environment.

.global

Action to take when reading the commit into env.

Value

discover_object_store returns a character vector whose elemnets are paths to existing object stores.

prepare_object_store returns an storage::object_store object.


lbartnik/experiment documentation built on May 20, 2019, 8:27 p.m.