Upload.httpapi: Upload R data and store() it into a SciDB array. Return a...

In Paradigm4/SciDBR: An R Interface to SciDB

Upload R data and store() it into a SciDB array. Return a scidb object wrapping the array. This function takes the same arguments as Upload but with extra optional arguments.

Description

Upload R data and store() it into a SciDB array. Return a scidb object wrapping the array. This function takes the same arguments as Upload but with extra optional arguments.

Usage

## S3 method for class 'httpapi'
Upload(
  db,
  payload,
  name = NULL,
  gc = TRUE,
  temp = FALSE,
  attr_names = NULL,
  attr_types = NULL,
  dim_names = NULL,
  dim_start_coordinates = NULL,
  dim_chunk_sizes = NULL,
  attrs = NULL,
  attr = NULL,
  types = NULL,
  type = NULL,
  start = NULL,
  chunk_size = NULL,
  ...
)

Arguments

db	scidb database connection returned from scidbconnect
payload	an R data frame, raw value, Matrix, matrix, or vector object
name	a SciDB array name to store the payload into, or NULL to generate a unique name
gc	(logical) if TRUE, the SciDB array will be removed when the return value gets garbage-collected. Set to FALSE to disconnect the SciDB array from R's garbage collector, i.e. to persist the SciDB array beyond the lifetime of this session.
temp	(logical) make the SciDB array a temporary array (only lasting for the lifetime of the session)
attr_names	names for the uploaded attributes; if not provided, the default names will vary depending on the type of object being uploaded. attrs and attr are allowable (but deprecated) synonyms for this parameter, for legacy compatibility.
attr_types	types of the uploaded attributes; if not provided, the types will be derived from the object being uploaded. types and type are allowable (but deprecated) synonyms for this parameter, for legacy compatibility.
dim_names	names for the dimensions in the uploaded array; if not provided, the dimension names will vary depending on the type of object being uploaded.
dim_start_coordinates	starting coordinates for each dimension; if not provided, dimension coordinates start at zero. start is an allowable (but deprecated) synonym for this parameter, for legacy compatibility.
dim_chunk_sizes	chunk sizes for each dimension; if not provided, the default chunk sizes will vary depending on the type of object being uploaded. chunk_size is an allowable (but deprecated) synonym for this parameter, for legacy compatibility.
...	other options, see implementations for each uploaded type

Value

A scidb object wrapping the uploaded SciDB array

See Also

Upload(), as.scidb()

Paradigm4/SciDBR documentation built on Nov. 9, 2023, 4:58 a.m.