Get object from iRODS collection

Get an object from an iRODS collection. If no collection is given, it uses the default collection.

Usage

ri_get(
  object,
  collection = ri_getCollection(),
  datadir = ri_getDatadir(),
  filename = object,
  overwrite = FALSE
)

Arguments

object

name of data object

collection

iRODS collection where data object resides

datadir

the local directory where to store the retrieved data object

filename

filename of retrieved data object

overwrite

should file be overwritting if allready exists

Value

nothing

Details

This function retrieves a data object from an iRODS collection. The default behaviour is to get the object from the default collection (see ri_setCollection) and store it in the local data directory (see ri_setDatadir ) using the data object's name as filename. Using the arguments collection, datadir, and filename it is possible to override this default behaviour.

A file is not overwritten if it allready exists in the data directory, use the overwrite argument to force writing of the file. If the file exists and overwrite=FALSE, then this function will generate an error