util: Set directory for remote database

Description Usage Arguments Details

Description

Utilities for "localDB" and "remoteDB" databases

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
setDir(db) <- value
copyDB(db, ...)
reposVersion(db, ...)
reposVersion(db) <- value

## S4 method for signature 'localDB'
initialize(.Object, ...)
## S4 method for signature 'remoteDB'
initialize(.Object, ...)

## S4 method for signature 'localDB'
copyDB(db, dir, ...)

Arguments

db

an object of class "remoteDB" or "localDB"

value

character, directory to be assigned

.Object

an object of class "localDB" or "remoteDB"

dir

directory into which the "localDB" should be copied

...

other arguments passed to methods

Details

Users obtaining "remoteDB" objects created on different machines may want to reset the directory specified for the local cache. The setDir replacement function is to be used for that purpose.

Users generally will not call the initialize functions directly, but rather will call them indirectly via the new function.

copyDB is used to copy a "localDB" database to another location (i.e. directory).

reposVersion returns the current repository version number and the replacement method can be used to set the repository to a different version number. A repository version of -1 indicates the most recent version.


rdpeng/stashr documentation built on May 27, 2019, 3:06 a.m.