set_runtime_objects: Sets new contents of the objectstorage.

Description Usage Arguments Value

View source: R/objectstorage.R

Description

The input objects will be compared with the stored objects, and replaced only when needed

Usage

1
2
3
4
5
set_runtime_objects(storagepath, obj.environment, objectnames = NULL,
  flag_forced_save_filenames = FALSE, flag_use_tmp_storage = FALSE,
  forced_archive_paths = NA, compress = "gzip",
  large_archive_prefix = NULL, locktimeout = NULL, wait_for = "save",
  parallel_cpus = NULL)

Arguments

storagepath

Path with the storage.

obj.environment

Environment or named list with the objects

objectnames

Character vector with the names of the objects to add. Defaults to all objects in the obj.environment.

flag_forced_save_filenames

Boolean vector with the length equal to objectnames, or named vector with objectnames as keys, or single value specifying whether to put a specific object in its own dedicated archive

flag_use_tmp_storage

Boolean vector with the length equal to objectnames, or named vector with objectnames as keys, or single value specifying whether if the temporary save file should be created in the fast /tmp directory first, and only then compressed into the target place.

forced_archive_paths

Character vector with the length equal to objectnames, or named vector with objectnames as keys, or single value specifying custom path of archive where a specific object(s) will saved.

compress

Character vector with the length equal to objectnames, or named vector with objectnames as keys, or single value specifying compression algorithm for each object. Compression will be applied archive-wise.

large_archive_prefix

If set, all new archives for large objects will be saved with this prefix, otherwise in the dirname(storagepath). storagepath. It is up to the user to make sure this directory is empty and no file name conflicts will arise.

Value

Returns 'data.frame' with the following columns:

objectname

Name of the stored object. This is a primary key.

digest

String with the digest of the object.

size

Numeric value with the size of the stored object.

forced_archive_paths

Path where the object is stored absolute or relative to the storage path.

single_object

Logical. TRUE if the archive contain only this one object. Otherwise archive contains named list of objects.

compress

Type of compression used to store this individual object


adamryczkowski/objectstorage documentation built on May 24, 2019, 8:47 p.m.