Sparse and Dense Multidimensional Array Storage Engine for Data Science


[Up] [Top]

Documentation for package ‘tiledb’ version 0.8.0

Help Pages

A C D E F G I L M N P R S T misc

tiledb-package tiledb - Interface to the TileDB Storage Manager API

-- A --

allows_dups Returns logical value whether the array schema allows duplicate values or not. This is only valid for sparse arrays.
allows_dups-method Returns logical value whether the array schema allows duplicate values or not. This is only valid for sparse arrays.
allows_dups<- Sets toggle whether the array schema allows duplicate values or not. This is only valid for sparse arrays.
allows_dups<--method Sets toggle whether the array schema allows duplicate values or not. This is only valid for sparse arrays.
as.data.frame.tiledb_config Convert a 'tiledb_config' object to a R data.frame
as.vector.tiledb_config Convert a 'tiledb_config' object to a R vector
as_data_frame Construct a data.frame from query results
attrs Generic Methods
attrs-method Retrieve attributes from 'tiledb_array' object
attrs-method Returns a list of all 'tiledb_attr' objects associated with the 'tiledb_array_schema'
attrs-method Returns a 'tiledb_attr' object associated with the 'tiledb_array_schema' with a given name.
attrs-method Returns a 'tiledb_attr' object associated with the 'tiledb_array_schema' with a given index
attrs-method Retrieve attributes from 'tiledb_dense' object
attrs-method Retrieve attributes from 'tiledb_sparse' object
attrs<- Selects attributes for the given TileDB array
attrs<--method Selects attributes for the given TileDB array
attrs<--method Selects attributes for the given TileDB array
attrs<--method Selects attributes for the given TileDB array

-- C --

cell_order Generic Methods
cell_order-method Returns the cell layout string associated with the 'tiledb_array_schema'
cell_val_num Generic Methods
cell_val_num-method Return the number of scalar values per attribute cell
config Generic Methods
config-method Retrieve the 'tiledb_config' object from the 'tiledb_ctx'

-- D --

datatype Generic Methods
datatype-method Return the 'tiledb_attr' datatype
datatype-method Return the 'tiledb_dim' datatype
datatype-method Returns tiledb_domain TileDB type string
dim.tiledb_array_schema Retrieve the dimension (domain extent) of the domain
dim.tiledb_dim Retrieves the dimension of the tiledb_dim domain
dim.tiledb_domain Retrieve the dimension (domain extent) of the domain
dimensions Generic Methods
dimensions-method Returns a list of 'tiledb_dim' objects associated with the 'tiledb_array_schema'
dimensions-method Returns a list of the tiledb_domain dimension objects
domain Generic Methods
domain-method Returns the 'tiledb_domain' object associated with a given 'tiledb_array_schema'
domain-method Return the 'tiledb_dim' domain

-- E --

extended Retrieve data.frame extended returns columns toggle
extended-method Retrieve data.frame extended returns columns toggle
extended<- Set data.frame extended return columns toggle
extended<--method Set data.frame extended return columns toggle

-- F --

filter_list Generic Methods
filter_list-method Returns the offsets and coordinate filter_lists associated with the 'tiledb_array_schema'
filter_list-method Returns the 'tiledb_filter_list' object associated with the given 'tiledb_attr'
fromDataFrame Create a TileDB Dense Array from a given 'data.frame' Object

-- G --

generics Generic Methods

-- I --

is.anonymous Returns TRUE if the tiledb_dim is anonymous
is.anonymous.tiledb_attr Returns TRUE if the tiledb_dim is anonymous
is.anonymous.tiledb_dim Returns TRUE if the tiledb_dim is anonymous
is.integral Generic Methods
is.integral-method Returns TRUE is tiledb_domain is an integral (integer) domain
is.sparse Generic Methods
is.sparse-method Returns TRUE if the tiledb_array_schema is sparse, else FALSE
is.sparse-method Returns true is if the array or array_schema is sparse
is.sparse-method Check if object is sparse

-- L --

limitTileDBCores Limit TileDB core use to a given number of cores

-- M --

max_chunk_size Generic Methods
max_chunk_size-method Returns the filter_list's max_chunk_size

-- N --

name Generic Methods
name-method Return the 'tiledb_attr' name
name-method Return the 'tiledb_dim' name
nfilters Generic Methods
nfilters-method Returns the filter_list's number of filters

-- P --

print.tiledb_metadata Print a TileDB Array Metadata object

-- R --

return.data.frame Retrieve data.frame return toggle
return.data.frame-method Retrieve data.frame return toggle
return.data.frame-method Retrieve data.frame return toggle
return.data.frame-method Retrieve data.frame return toggle
return.data.frame<- Set data.frame return toggle
return.data.frame<--method Set data.frame return toggle
return.data.frame<--method Set data.frame return toggle
return.data.frame<--method Set data.frame return toggle
r_to_tiledb_type Look up TileDB type corresponding to the type of an R object

-- S --

schema Generic Methods
schema-method Return a schema from a tiledb_array object
schema-method Returns the 'tiledb_dense' array 'tiledb_schema' object
schema-method Return a schema from a sparse array
selected_ranges Retrieve selected_ranges values for the array
selected_ranges-method Retrieve selected_ranges values for the array
selected_ranges<- Set selected_ranges return values for the array
selected_ranges<--method Set selected_ranges return values for the array
set_max_chunk_size Generic Methods
set_max_chunk_size-method Set the filter_list's max_chunk_size
show-method Prints a tiledb_array object
show-method Prints an array schema object
show-method Prints an attribute object
show-method Prints the config object to STDOUT
show-method Prints a tiledb_dense array object
show-method Prints an domain object
show-method Prints a tiledb_sparse array object

-- T --

tile Generic Methods
tile-method Return the 'tiledb_dim' tile extent
tiledb_array Constructs a tiledb_array object backed by a persisted tiledb array uri
tiledb_array-class An S4 class for a TileDB Array
tiledb_array_close Close a TileDB Array
tiledb_array_create Creates a new TileDB array given an input schema.
tiledb_array_is_heterogeneous Check for Heterogeneous Domain
tiledb_array_is_homogeneous Check for Homogeneous Domain
tiledb_array_open Open a TileDB Array
tiledb_array_schema Constructs a 'tiledb_array_schema' object
tiledb_array_schema-class An S4 class for the TileDB array schema
tiledb_attr Contructs a 'tiledb_attr' object
tiledb_attr-class An S4 class for a TileDB attribute
tiledb_config Creates a 'tiledb_config' object
tiledb_config-class An S4 class for a TileDB configuration
tiledb_config_load Load a saved 'tiledb_config' file from disk
tiledb_config_save Save a 'tiledb_config' object ot a local text file
tiledb_ctx Creates a 'tiledb_ctx' object
tiledb_ctx-class An S4 class for a TileDB context
tiledb_ctx_set_default_tags Sets default context tags
tiledb_ctx_set_tag Sets a string:string "tag" on the Ctx
tiledb_delete_metadata Delete a TileDB Array Metadata object given by key
tiledb_dense Constructs a tiledb_dense object backed by a persisted tiledb array uri
tiledb_dense-class An S4 class for a TileDB dense array
tiledb_dim Contructs a 'tiledb_dim' object
tiledb_dim-class An S4 class for a TileDB dimension object
tiledb_domain Constructs a 'tiledb_domain' object
tiledb_domain-class An S4 class for a TileDB domain
tiledb_filter Constructs a 'tiledb_filter' object
tiledb_filter-class An S4 class for a TileDB filter
tiledb_filter_get_option Returns the filter's option
tiledb_filter_list Constructs a 'tiledb_filter_list' object
tiledb_filter_list-class An S4 class for a TileDB filter list
tiledb_filter_set_option Set the filter's option
tiledb_filter_type Returns the type of the filter used
tiledb_get_all_metadata Return a TileDB Array Metadata object given by key
tiledb_get_context Retrieve a TileDB context object from the package cache
tiledb_get_metadata Return a TileDB Array Metadata object given by key
tiledb_group_create Creates a TileDB group object at given uri path
tiledb_has_metadata Test if TileDB Array has Metadata
tiledb_is_supported_fs Query if a TileDB backend is supported
tiledb_ndim Generic Methods
tiledb_ndim-method Return the number of dimensions associated with the 'tiledb_array_schema'
tiledb_ndim-method Returns the number of dimensions for a tiledb domain object
tiledb_ndim-method Returns the number of dimensions of the 'tiledb_domain'
tiledb_num_metadata Return count of TileDB Array Metadata objects
tiledb_object_ls List TileDB resources at a given root URI path
tiledb_object_mv Move a TileDB resource to new uri path
tiledb_object_rm Removes a TileDB resource
tiledb_object_type Return the TileDB object type string of a TileDB resource
tiledb_object_walk Recursively discover TileDB resources at a given root URI path
tiledb_put_metadata Store an object in TileDB Array Metadata under given key
tiledb_query Creates a 'tiledb_query' object
tiledb_query-class An S4 class for a TileDB Query object
tiledb_query_add_range Set a range for a given query
tiledb_query_add_range_with_type Set a range for a given query
tiledb_query_alloc_buffer_ptr_char Allocate a Query buffer for reading a character attribute
tiledb_query_alloc_buffer_ptr_char_subarray Allocate a Query buffer for reading a character attribute using a subarray
tiledb_query_buffer_alloc_ptr Allocate a Query buffer for a given type
tiledb_query_create_buffer_ptr Allocate and populate a Query buffer for a given object of a given data type.
tiledb_query_create_buffer_ptr_char Allocate and populate a Query buffer for writing the given char vector
tiledb_query_finalize Finalize TileDB Query
tiledb_query_get_buffer_char Retrieve content from a Query character buffer
tiledb_query_get_buffer_ptr Retrieve content from a Query buffer
tiledb_query_get_layout Get TileDB Query layout
tiledb_query_result_buffer_elements Get TileDB Query result buffer elements
tiledb_query_set_buffer Set TileDB Query buffer
tiledb_query_set_buffer_ptr Assigns to a Query buffer for a given attribute
tiledb_query_set_buffer_ptr_char Assign a buffer to a Query attribute
tiledb_query_set_layout Set TileDB Query layout
tiledb_query_set_subarray Set subarray for TileDB Query object
tiledb_query_status Get TileDB Query status
tiledb_query_submit Submit TileDB Query
tiledb_query_type Return TileDB Query type
tiledb_schema_get_names Get all Dimension and Attribute Names
tiledb_schema_get_types Get all Dimension and Attribute Types
tiledb_set_context Store a TileDB context object in the package cache
tiledb_sparse Constructs a tiledb_sparse object backed by a persisted tiledb array uri
tiledb_sparse-class An S4 class for a TileDB sparse array
tiledb_stats_disable Disable stats counters
tiledb_stats_dump Dump stats to file
tiledb_stats_enable Enable stats counters
tiledb_subarray Query a array using a subarray vector
tiledb_version The version of the libtiledb library
tiledb_vfs Creates a 'tiledb_vfs' object
tiledb_vfs-class An S4 class for a TileDB VFS object
tiledb_vfs_create_bucket Create a VFS Bucket
tiledb_vfs_create_dir Create a VFS Directory
tiledb_vfs_empty_bucket Empty a VFS Bucket
tiledb_vfs_file_size Return VFS File Size
tiledb_vfs_is_bucket Check for VFS Bucket
tiledb_vfs_is_dir Test for VFS Directory
tiledb_vfs_is_empty_bucket Check for empty VFS Bucket
tiledb_vfs_is_file Test for VFS File
tiledb_vfs_move_dir Move (or rename) a VFS Directory
tiledb_vfs_move_file Move (or rename) a VFS File
tiledb_vfs_remove_bucket Remove a VFS Bucket
tiledb_vfs_remove_dir Remove a VFS Directory
tiledb_vfs_remove_file Remove a VFS File
tiledb_vfs_touch Touch a VFS URI Resource
tile_order Generic Methods
tile_order-method Returns the tile layout string associated with the 'tiledb_array_schema'

-- misc --

[,tiledb_array Returns a TileDB array, allowing for specific subset ranges.
[,tiledb_config Gets a config parameter value
[,tiledb_dense Gets a dense array value
[,tiledb_filter_list Returns the filter at given index
[,tiledb_sparse Gets a sparse array value
[-method Returns a TileDB array, allowing for specific subset ranges.
[-method Gets a config parameter value
[-method Gets a dense array value
[-method Returns the filter at given index
[-method Gets a sparse array value
[<-,tiledb_array Sets a tiledb array value or value range
[<-,tiledb_config Sets a config parameter value
[<-,tiledb_dense Sets a dense array value
[<-,tiledb_sparse Sets a sparse array value
[<--method Sets a tiledb array value or value range
[<--method Sets a config parameter value
[<--method Sets a dense array value
[<--method Sets a sparse array value