Skip to contents

Ctx

tiledb_ctx-class
An S4 class for a TileDB context
tiledb_ctx()
Creates a tiledb_ctx object
tiledb_ctx_set_default_tags()
Sets default context tags
tiledb_ctx_set_tag()
Sets a string:string "tag" on the Ctx
tiledb_ctx_stats()
Return context statistics as a JSON string
tiledb_is_supported_fs()
Query if a TileDB backend is supported
tiledb_get_context()
Retrieve a TileDB context object from the package cache
tiledb_set_context()
Store a TileDB context object in the package cache
config(<tiledb_ctx>)
Retrieve the tiledb_config object from the tiledb_ctx

Config

tiledb_config-class
An S4 class for a TileDB configuration
tiledb_config()
Creates a tiledb_config object
tiledb_config_as_built_json()
Return the 'AsBuilt' JSON string
tiledb_config_as_built_show()
Display the 'AsBuilt' JSON string
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_config_unset()
Unset a TileDB Config parameter to its default value
as.vector(<tiledb_config>)
Convert a tiledb_config object to a R vector
as.data.frame(<tiledb_config>)
Convert a tiledb_config object to a R data.frame
show(<tiledb_config>)
Prints the config object to STDOUT
`[`(<tiledb_config>,<ANY>)
Gets a config parameter value
`[<-`(<tiledb_config>,<ANY>,<ANY>,<ANY>)
Sets a config parameter value
save_allocation_size_preference() load_allocation_size_preference() get_allocation_size_preference() set_allocation_size_preference()
Store allocation size preference

Array

tiledb_array_create()
Creates a new TileDB array given an input schema.
tiledb_array() tiledb_dense() tiledb_sparse()
Constructs a tiledb_array object backed by a persisted tiledb array uri
`attrs<-`(<tiledb_array>)
Selects attributes for the given TileDB array
attrs(<tiledb_array>,<ANY>)
Retrieve attributes from tiledb_array object
attrs(<tiledb_array_schema>,<ANY>)
Returns a list of all tiledb_attr objects associated with the tiledb_array_schema
attrs(<tiledb_array_schema>,<character>)
Returns a tiledb_attr object associated with the tiledb_array_schema with a given name.
attrs(<tiledb_array_schema>,<numeric>)
Returns a tiledb_attr object associated with the tiledb_array_schema with a given index
cell_order(<tiledb_array_schema>)
Returns the cell layout string associated with the tiledb_array_schema
`datetimes_as_int64<-`()
Set datetimes_as_int64 toggle
datetimes_as_int64()
Retrieve datetimes_as_int64 toggle
dim(<tiledb_array_schema>)
Retrieve the dimension (domain extent) of the domain
dimensions(<tiledb_array_schema>)
Returns a list of tiledb_dim objects associated with the tiledb_array_schema
domain(<tiledb_array_schema>)
Returns the tiledb_domain object associated with a given tiledb_array_schema
`extended<-`()
Set data.frame extended return columns toggle
extended()
Retrieve data.frame extended returns columns toggle
filter_list(<tiledb_array_schema>)
Returns the offsets and coordinate filter_lists associated with the tiledb_array_schema
is.sparse(<tiledb_array_schema>)
Returns TRUE if the tiledb_array_schema is sparse, else FALSE
`query_condition<-`()
Set query_condition object for the array
query_condition()
Retrieve query_condition value for the array
`query_layout<-`()
Set query_layout return values for the array
query_layout()
Retrieve query_layout values for the array
`query_statistics<-`()
Set query_statistics toggle
query_statistics()
Retrieve query_statistics toggle
raw_dump(<tiledb_array_schema>)
Raw display of an array schema object
`return.array<-`()
Set array return toggle
return.array()
Retrieve array return toggle
`return.data.frame<-`(<tiledb_array>)
Set data.frame return toggle
return.data.frame(<tiledb_array>)
Retrieve data.frame return toggle
`return.matrix<-`()
Set matrix return toggle
return.matrix()
Retrieve matrix return toggle
`return_as<-`()
Retrieve return_as conversion preference
return_as()
Retrieve return_as conversion preference
schema(<tiledb_array>)
Return a schema from a tiledb_array object
`selected_points<-`()
Set selected_points return values for the array
selected_points()
Retrieve selected_points values for the array
`selected_ranges<-`()
Set selected_ranges return values for the array
selected_ranges()
Retrieve selected_ranges values for the array
show(<tiledb_array>)
Prints a tiledb_array object
show(<tiledb_array_schema>)
Prints an array schema object
`strings_as_factors<-`()
Set strings_as_factors return toggle
strings_as_factors()
Retrieve strings_as_factors conversion toggle
`[`(<tiledb_array>,<ANY>)
Returns a TileDB array, allowing for specific subset ranges.
`[<-`(<tiledb_array>,<ANY>,<ANY>,<ANY>)
Sets a tiledb array value or value range
tdb_collect(<tiledb_array>)
Collect the query results to finalize piped expression
tdb_filter(<tiledb_array>)
Filter from array for query via logical conditions
tdb_select(<tiledb_array>)
Select attributes from array for query
tile_order(<tiledb_array_schema>)
Returns the tile layout string associated with the tiledb_array_schema
tiledb_array-class
An S4 class for a TileDB Array
tiledb_array_apply_aggregate()
Run an aggregate query on the given (sparse) array and attribute
tiledb_array_close()
Close a TileDB Array
tiledb_array_delete_fragments()
Delete fragments written between the start and end times given
tiledb_array_get_non_empty_domain_from_index()
Get the non-empty domain from a TileDB Array by index
tiledb_array_get_non_empty_domain_from_name()
Get the non-empty domain from a TileDB Array by name
tiledb_array_has_enumeration()
Check for Enumeration (aka Factor aka Dictionary)
tiledb_array_is_heterogeneous()
Check for Heterogeneous Domain
tiledb_array_is_homogeneous()
Check for Homogeneous Domain
tiledb_array_is_open()
Test if TileDB Array is open
tiledb_array_open()
Open a TileDB Array
tiledb_array_open_at()
Open a TileDB Array at Timestamp
tiledb_array_schema-class
An S4 class for the TileDB array schema
tiledb_array_schema()
Constructs a tiledb_array_schema object
schema_check() check() tiledb_array_schema_check()
Check the schema for correctness
tiledb_array_schema_evolution-class
An S4 class for a TileDB ArraySchemaEvolution object
tiledb_array_schema_evolution()
Creates a 'tiledb_array_schema_evolution' object
tiledb_array_schema_evolution_add_attribute()
Add an Attribute to a TileDB Array Schema Evolution object
tiledb_array_schema_evolution_add_enumeration()
Add an Enumeration to a TileDB Array Schema Evolution object
tiledb_array_schema_evolution_add_enumeration_empty()
Evolve an Array Schema by adding an empty Enumeration
tiledb_array_schema_evolution_array_evolve()
Evolve an Array Schema
tiledb_array_schema_evolution_drop_attribute()
Drop an attribute given by name from a TileDB Array Schema Evolution object
tiledb_array_schema_evolution_drop_enumeration()
Drop an Enumeration given by name from a TileDB Array Schema Evolution object
tiledb_array_schema_evolution_extend_enumeration()
Extend an Evolution via Array Schema Evolution
allows_dups() tiledb_array_schema_get_allows_dups()
Returns logical value whether the array schema allows duplicate values or not. This is only valid for sparse arrays.
capacity() tiledb_array_schema_get_capacity()
Retrieve schema capacity (for sparse fragments)
`allows_dups<-`() tiledb_array_schema_set_allows_dups()
Sets toggle whether the array schema allows duplicate values or not. This is only valid for sparse arrays.
`capacity<-`() tiledb_array_schema_set_capacity()
Sets the schema capacity (for sparse fragments)
tiledb_array_schema_set_coords_filter_list()
Set a Filter List for Coordinate of a TileDB Schema
tiledb_array_schema_set_enumeration_empty()
Add an empty Enumeration to a Schema
tiledb_array_schema_set_offsets_filter_list()
Set a Filter List for Variable-Sized Offsets of a TileDB Schema
tiledb_array_schema_set_validity_filter_list()
Set a Filter List for Validity of a TileDB Schema
tiledb_array_schema_version()
Check the version of the array schema
tiledb_ndim(<tiledb_array_schema>)
Return the number of dimensions associated with the tiledb_array_schema
tiledb_subarray-class
An S4 class for a TileDB Subarray
tiledb_subarray()
Constructs a tiledb_subarray object from a TileDB Query
tiledb_subarray_to_query()
Apply a Subarray to a Query
save_return_as_preference() load_return_as_preference() get_return_as_preference() set_return_as_preference()
Store object conversion preference
tiledb_datatype_R_type()
Map from TileDB type to R datatype

ArraySchema

tiledb_array_schema-class
An S4 class for the TileDB array schema
tiledb_array_schema()
Constructs a tiledb_array_schema object
schema_check() check() tiledb_array_schema_check()
Check the schema for correctness
tiledb_array_schema_evolution-class
An S4 class for a TileDB ArraySchemaEvolution object
tiledb_array_schema_evolution()
Creates a 'tiledb_array_schema_evolution' object
tiledb_array_schema_evolution_add_attribute()
Add an Attribute to a TileDB Array Schema Evolution object
tiledb_array_schema_evolution_add_enumeration()
Add an Enumeration to a TileDB Array Schema Evolution object
tiledb_array_schema_evolution_add_enumeration_empty()
Evolve an Array Schema by adding an empty Enumeration
tiledb_array_schema_evolution_array_evolve()
Evolve an Array Schema
tiledb_array_schema_evolution_drop_attribute()
Drop an attribute given by name from a TileDB Array Schema Evolution object
tiledb_array_schema_evolution_drop_enumeration()
Drop an Enumeration given by name from a TileDB Array Schema Evolution object
tiledb_array_schema_evolution_extend_enumeration()
Extend an Evolution via Array Schema Evolution
allows_dups() tiledb_array_schema_get_allows_dups()
Returns logical value whether the array schema allows duplicate values or not. This is only valid for sparse arrays.
capacity() tiledb_array_schema_get_capacity()
Retrieve schema capacity (for sparse fragments)
`allows_dups<-`() tiledb_array_schema_set_allows_dups()
Sets toggle whether the array schema allows duplicate values or not. This is only valid for sparse arrays.
`capacity<-`() tiledb_array_schema_set_capacity()
Sets the schema capacity (for sparse fragments)
tiledb_array_schema_set_coords_filter_list()
Set a Filter List for Coordinate of a TileDB Schema
tiledb_array_schema_set_enumeration_empty()
Add an empty Enumeration to a Schema
tiledb_array_schema_set_offsets_filter_list()
Set a Filter List for Variable-Sized Offsets of a TileDB Schema
tiledb_array_schema_set_validity_filter_list()
Set a Filter List for Validity of a TileDB Schema
tiledb_array_schema_version()
Check the version of the array schema
r_to_tiledb_type()
Look up TileDB type corresponding to the type of an R object
tiledb_schema_get_names()
Get all Dimension and Attribute Names
tiledb_schema_get_types()
Get all Dimension and Attribute Types
tiledb_schema_get_dim_attr_status()
Get Dimension or Attribute Status
attrs(<tiledb_array_schema>,<character>)
Returns a tiledb_attr object associated with the tiledb_array_schema with a given name.
schema(<character>)
Return a schema from a URI character value
tiledb_schema_object()
Succinctly describe a TileDB array schema
describe()
Describe a TileDB array schema via code to create it

Attribute

tiledb_attr-class
An S4 class for a TileDB attribute
tiledb_attr()
Contructs a tiledb_attr object
tiledb_attribute_get_cell_size()
Get the TileDB Attribute cell size
cell_val_num() tiledb_attribute_get_cell_val_num()
Return the number of scalar values per attribute cell
tiledb_attribute_get_enumeration() tiledb_attribute_get_enumeration_ptr()
Get the TileDB Attribute Enumeration
tiledb_attribute_get_fill_value()
Get the fill value for a TileDB Attribute
tiledb_attribute_get_nullable()
Get the TileDB Attribute Nullable flag value
tiledb_attribute_has_enumeration()
Test if TileDB Attribute has an Enumeration
tiledb_attribute_is_ordered_enumeration_ptr()
Check if TileDB Attribute Enumeration is Ordered
tiledb_attribute_is_variable_sized()
Check whether TileDB Attribute is variable-sized
`cell_val_num<-`() tiledb_attribute_set_cell_val_num()
Set the number of scalar values per attribute cell
tiledb_attribute_set_enumeration_name()
Set a TileDB Attribute Enumeration Name
tiledb_attribute_set_fill_value()
Set the fill value for a TileDB Attribute
tiledb_attribute_set_nullable()
Set the TileDB Attribute Nullable flags
`attrs<-`(<tiledb_array>)
Selects attributes for the given TileDB array
attrs(<tiledb_array>,<ANY>)
Retrieve attributes from tiledb_array object
attrs(<tiledb_array_schema>,<ANY>)
Returns a list of all tiledb_attr objects associated with the tiledb_array_schema
attrs(<tiledb_array_schema>,<character>)
Returns a tiledb_attr object associated with the tiledb_array_schema with a given name.
attrs(<tiledb_array_schema>,<numeric>)
Returns a tiledb_attr object associated with the tiledb_array_schema with a given index
schema() return.data.frame() `return.data.frame<-`() `attrs<-`() raw_dump() domain() dimensions() attrs() cell_order() tile_order() filter_list() `filter_list<-`() is.sparse() tiledb_ndim() name() datatype() config() tile() is.integral() nfilters() tdb_filter() tdb_select() tdb_collect()
Generic Methods
datatype(<tiledb_attr>)
Return the tiledb_attr datatype
`filter_list<-`(<tiledb_attr>)
Sets the TileDB Filter List for the TileDB Attribute object
filter_list(<tiledb_attr>)
Returns the TileDB Filter List object associated with the given TileDB Attribute
name(<tiledb_attr>)
Return the tiledb_attr name
raw_dump(<tiledb_attr>)
Raw display of an attribute object
show(<tiledb_attr>)
Prints an attribute object
has_attribute()
Check a schema for a given attribute name

Filter

tiledb_filter-class
An S4 class for a TileDB filter
tiledb_filter()
Constructs a tiledb_filter object
tiledb_filter_get_option()
Returns the filter's option
tiledb_filter_list-class
An S4 class for a TileDB filter list
tiledb_filter_list()
Constructs a tiledb_filter_list object
max_chunk_size() tiledb_filter_list_get_max_chunk_size()
Returns the filter_list's max_chunk_size
set_max_chunk_size() tiledb_filter_list_set_max_chunk_size()
Set the filter_list's max_chunk_size
tiledb_filter_set_option()
Set the option for a filter
tiledb_filter_type()
Returns the type of the filter used
`filter_list<-`(<tiledb_attr>)
Sets the TileDB Filter List for the TileDB Attribute object
`filter_list<-`(<tiledb_dim>)
Sets the TileDB Filter List for the TileDB Dimension object
filter_list(<tiledb_array_schema>)
Returns the offsets and coordinate filter_lists associated with the tiledb_array_schema
filter_list(<tiledb_attr>)
Returns the TileDB Filter List object associated with the given TileDB Attribute
filter_list(<tiledb_dim>)
Returns the TileDB Filter List object associated with the given TileDB Dimension
schema() return.data.frame() `return.data.frame<-`() `attrs<-`() raw_dump() domain() dimensions() attrs() cell_order() tile_order() filter_list() `filter_list<-`() is.sparse() tiledb_ndim() name() datatype() config() tile() is.integral() nfilters() tdb_filter() tdb_select() tdb_collect()
Generic Methods
show(<tiledb_filter>)
Prints a filter object

FilterList

nfilters(<tiledb_filter_list>)
Returns the filter_list's number of filters
show(<tiledb_filter_list>)
Prints a filter_list object
`[`(<tiledb_filter_list>,<ANY>)
Returns the filter at given index
tiledb_filter_list-class
An S4 class for a TileDB filter list
tiledb_filter_list()
Constructs a tiledb_filter_list object
max_chunk_size() tiledb_filter_list_get_max_chunk_size()
Returns the filter_list's max_chunk_size
set_max_chunk_size() tiledb_filter_list_set_max_chunk_size()
Set the filter_list's max_chunk_size
`filter_list<-`(<tiledb_attr>)
Sets the TileDB Filter List for the TileDB Attribute object
`filter_list<-`(<tiledb_dim>)
Sets the TileDB Filter List for the TileDB Dimension object
filter_list(<tiledb_array_schema>)
Returns the offsets and coordinate filter_lists associated with the tiledb_array_schema
filter_list(<tiledb_attr>)
Returns the TileDB Filter List object associated with the given TileDB Attribute
filter_list(<tiledb_dim>)
Returns the TileDB Filter List object associated with the given TileDB Dimension
schema() return.data.frame() `return.data.frame<-`() `attrs<-`() raw_dump() domain() dimensions() attrs() cell_order() tile_order() filter_list() `filter_list<-`() is.sparse() tiledb_ndim() name() datatype() config() tile() is.integral() nfilters() tdb_filter() tdb_select() tdb_collect()
Generic Methods

Domain

tiledb_domain-class
An S4 class for a TileDB domain
tiledb_domain()
Constructs a tiledb_domain object
tiledb_domain_get_dimension_from_index()
Returns a Dimension indicated by index for the given TileDB Domain
tiledb_domain_get_dimension_from_name()
Returns a Dimension indicated by name for the given TileDB Domain
tiledb_domain_has_dimension()
Check a domain for a given dimension name
schema() return.data.frame() `return.data.frame<-`() `attrs<-`() raw_dump() domain() dimensions() attrs() cell_order() tile_order() filter_list() `filter_list<-`() is.sparse() tiledb_ndim() name() datatype() config() tile() is.integral() nfilters() tdb_filter() tdb_select() tdb_collect()
Generic Methods
tiledb_ndim(<tiledb_array_schema>)
Return the number of dimensions associated with the tiledb_array_schema
tiledb_ndim(<tiledb_dim>)
Returns the number of dimensions for a tiledb domain object
tiledb_ndim(<tiledb_domain>)
Returns the number of dimensions of the tiledb_domain
datatype(<tiledb_domain>)
Returns the tiledb_domain TileDB type string
dimensions(<tiledb_domain>)
Returns a list of the tiledb_domain dimension objects
is.integral(<tiledb_domain>)
Returns TRUE is tiledb_domain is an integral (integer) domain
raw_dump(<tiledb_domain>)
Raw display of a domain object
show(<tiledb_domain>)
Prints a domain object

Dim

tiledb_dim-class
An S4 class for a TileDB dimension object
tiledb_dim()
Contructs a tiledb_dim object
cell_val_num(<tiledb_dim>) tiledb_dim_get_cell_val_num()
Return the number of scalar values per dimension cell
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(<tiledb_array_schema>)
Returns a list of tiledb_dim objects associated with the tiledb_array_schema
dimensions(<tiledb_domain>)
Returns a list of the tiledb_domain dimension objects
schema() return.data.frame() `return.data.frame<-`() `attrs<-`() raw_dump() domain() dimensions() attrs() cell_order() tile_order() filter_list() `filter_list<-`() is.sparse() tiledb_ndim() name() datatype() config() tile() is.integral() nfilters() tdb_filter() tdb_select() tdb_collect()
Generic Methods
datatype(<tiledb_dim>)
Return the tiledb_dim datatype
domain(<tiledb_dim>)
Return the tiledb_dim domain
`filter_list<-`(<tiledb_dim>)
Sets the TileDB Filter List for the TileDB Dimension object
filter_list(<tiledb_dim>)
Returns the TileDB Filter List object associated with the given TileDB Dimension
name(<tiledb_dim>)
Return the tiledb_dim name
show(<tiledb_dim>)
Prints a dimension object
tile(<tiledb_dim>)
Return the tiledb_dim tile extent
tiledb_ndim(<tiledb_dim>)
Returns the number of dimensions for a tiledb domain object
is.anonymous(<tiledb_dim>)
Returns TRUE if the tiledb_dim is anonymous

Query

query object functions

tiledb_query-class
An S4 class for a TileDB Query object
tiledb_query()
Creates 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, also supplying type
tiledb_query_alloc_buffer_ptr_char()
Allocate a Query buffer for reading a character attribute
tiledb_query_apply_aggregate()
Run an aggregate oprtation on the given query attribute
tiledb_query_buffer_alloc_ptr()
Allocate a Query buffer for a given type
tiledb_query_condition-class
An S4 class for a TileDB QueryCondition object
tiledb_query_condition()
Creates a 'tiledb_query_condition' object
tiledb_query_condition_combine()
Combine two 'tiledb_query_condition' objects
tiledb_query_condition_create()
create a query condition for vector 'IN' and 'NOT_IN' operations
tiledb_query_condition_init()
Initialize a 'tiledb_query_condition' object
tiledb_query_condition_set_use_enumeration()
Enable use of enumeration in query condition
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_ctx()
Return query context object
tiledb_query_export_buffer()
Export Query Buffer to Pair of Arrow IO Pointers
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_est_result_size()
Retrieve the estimated result size for a query and attribute
tiledb_query_get_est_result_size_var()
Retrieve the estimated result size for a query and variable-sized attribute
tiledb_query_get_fragment_num()
Retrieve the Number of Fragments for Query
tiledb_query_get_fragment_timestamp_range()
Retrieve the timestamp range for a given Query Fragment
tiledb_query_get_fragment_uri()
Retrieve the URI for a given Query Fragment
tiledb_query_get_layout()
Get TileDB Query layout
tiledb_query_get_range() tiledb_query_get_range()
Retrieve the query range for a query dimension and range index
tiledb_query_get_range_num()
Retrieve the number of ranges for a query dimension
tiledb_query_import_buffer()
Import to Query Buffer from Pair of Arrow IO Pointers
tiledb_query_result_buffer_elements()
Get TileDB Query result buffer element size
tiledb_query_result_buffer_elements_vec()
Get TileDB Query result buffer element size pair as vector
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_condition()
Set a query combination object for a query
tiledb_query_set_layout()
Set TileDB Query layout
tiledb_query_set_subarray()
Set subarray for TileDB Query object
tiledb_query_stats()
Return query statistics as a JSON string
tiledb_query_status()
Get TileDB Query status
tiledb_query_submit()
Submit TileDB Query
tiledb_query_submit_async()
Submit TileDB Query asynchronously without a callback returning immediately
tiledb_query_type()
Return TileDB Query type
parse_query_condition()
Create a 'tiledb_query_condition' object from an expression
tiledb_get_query_status()
Retrieve the cached status of the last finalized query
tiledb_error_message()
Return the error message for a given context
completedBatched()
Check ‘batched’ query for completion
createBatched()
Create a ‘batched’ query object
fetchBatched()
Run a ‘batched’ query
statusBatched()
Return ‘batched’ status

Group

tiledb_group-class
An S4 class for a TileDB Group object
tiledb_group()
Creates a 'tiledb_group' object
tiledb_group_add_member()
Add Member to TileDB Group
tiledb_group_close()
Close a TileDB Group
tiledb_group_create()
Create a TileDB Group at the given path
tiledb_group_delete_metadata()
Deletes Metadata from a TileDB Group
tiledb_group_get_all_metadata()
Return all Metadata from a TileDB Group
tiledb_group_get_config()
Get a TileDB Config from a TileDB Group
tiledb_group_get_metadata()
Accesses Metadata from a TileDB Group
tiledb_group_get_metadata_from_index()
Accesses Metadata by Index from a TileDB Group
tiledb_group_has_metadata()
Checks for Metadata in a TileDB Group
tiledb_group_is_open()
Test if TileDB Group is open
tiledb_group_is_relative()
Test if a Named Group is Using a Relative URI
tiledb_group_member()
Get a Member (Description) by Index from TileDB Group
tiledb_group_member_count()
Get Member Count from TileDB Group
tiledb_group_member_dump()
Dump the TileDB Group to String
tiledb_group_metadata_num()
Returns Number of Metadata Objects a TileDB Group
tiledb_group_open()
Open a TileDB Group
tiledb_group_put_metadata()
Write Metadata to a TileDB Group
tiledb_group_query_type()
Return a TileDB Group query type
tiledb_group_remove_member()
Remove Member from TileDB Group
tiledb_group_set_config()
Set a TileDB Config for a TileDB Group
tiledb_group_uri()
Return a TileDB Group URI
show(<tiledb_group>)
Display the TileDB Group object to STDOUT

Object

object management functions

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
is.anonymous()
Returns TRUE if the tiledb_dim is anonymous
is.anonymous(<tiledb_dim>)
Returns TRUE if the tiledb_dim is anonymous
array_consolidate()
Consolidate fragments of a TileDB Array
array_vacuum()
After consolidation, remove consolidated fragments of a TileDB Array

MetaData

arrray metadata functionality

print(<tiledb_metadata>)
Print a TileDB Array Metadata object
tiledb_delete_metadata()
Delete a TileDB Array Metadata object given by key
tiledb_fragment_info_has_consolidated_metadata()
Return if a fragment info index has consolidated metadata
tiledb_get_all_metadata()
Return all TileDB Array Metadata objects as a named list
tiledb_get_metadata()
Return a TileDB Array Metadata object given by key
tiledb_group_delete_metadata()
Deletes Metadata from a TileDB Group
tiledb_group_get_all_metadata()
Return all Metadata from a TileDB Group
tiledb_group_get_metadata()
Accesses Metadata from a TileDB Group
tiledb_group_has_metadata()
Checks for Metadata in a TileDB Group
tiledb_group_put_metadata()
Write Metadata to a TileDB Group
tiledb_has_metadata()
Test if TileDB Array has Metadata
tiledb_num_metadata()
Return count of TileDB Array Metadata objects
tiledb_put_metadata()
Store an object in TileDB Array Metadata under given key

Stats

performance stat collection functions

tiledb_stats_disable()
Disable internal TileDB statistics counters
tiledb_stats_dump()
Dumps internal TileDB statistics to file or stdout
tiledb_stats_enable()
Enable internal TileDB statistics counters
tiledb_stats_print()
Print internal TileDB statistics
tiledb_stats_raw_dump()
Dumps internal TileDB statistics as JSON to a string
tiledb_stats_raw_get()
Gets internal TileDB statistics as JSON string
tiledb_stats_raw_print()
Print internal TileDB statistics as JSON
tiledb_stats_reset()
Reset internal TileDB statistics counters

VFS

virtual file system functions

tiledb_vfs-class
An S4 class for a TileDB VFS object
tiledb_vfs()
Creates a tiledb_vfs object
tiledb_vfs_close()
Close a TileDB VFS Filehandle
tiledb_vfs_copy_file()
Copy a file to VFS
tiledb_vfs_create_bucket()
Create a VFS Bucket
tiledb_vfs_create_dir()
Create a VFS Directory
tiledb_vfs_dir_size()
Return VFS Directory Size
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_ls()
Return VFS Directory Listing
tiledb_vfs_move_dir()
Move (or rename) a VFS Directory
tiledb_vfs_move_file()
Move (or rename) a VFS File
tiledb_vfs_open()
Open a TileDB VFS Filehandle for reading or writing
tiledb_vfs_read()
Read from a TileDB VFS Filehandle
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_serialize()
Serialize an R Object to a VFS-accessible URI
tiledb_vfs_sync()
Sync a TileDB VFS Filehandle
tiledb_vfs_touch()
Touch a VFS URI Resource
tiledb_vfs_unserialize()
Unserialize an R Object from a VFS-accessible URI
tiledb_vfs_write()
Write to a TileDB VFS Filehandle
tiledb_get_vfs()
Retrieve a TileDB VFS object from the package environment and cache
tiledb_set_vfs()
Store a TileDB VFS object in the package environment

Filestore

filestore functionality

tiledb_filestore_buffer_export()
Export from a TileDB Filestore to a character variable
tiledb_filestore_buffer_import()
Import size bytes from a string into a TileDB Filestore
tiledb_filestore_schema_create()
Create an array schema from a given URI with schema
tiledb_filestore_size()
Return (uncompressed) TileDB Filestore size
tiledb_filestore_uri_export()
Export a file from a TileDB Filestore
tiledb_filestore_uri_import()
Import a file into a TileDB Filestore

Fragment

tiledb_fragment_info-class
An S4 class for a TileDB fragment info object
tiledb_fragment_info()
Constructs a tiledb_fragment_info object
tiledb_fragment_info_dense()
Return if a fragment info index is dense
tiledb_fragment_info_dump()
Dump the fragment info to console
tiledb_fragment_info_get_cell_num()
Return a fragment info number of cells for a given fragment index
tiledb_fragment_info_get_non_empty_domain_index()
Return a fragment info non-empty domain from index
tiledb_fragment_info_get_non_empty_domain_name()
Return a fragment info non-empty domain from name
tiledb_fragment_info_get_non_empty_domain_var_index()
Return a fragment info non-empty domain variable from index
tiledb_fragment_info_get_non_empty_domain_var_name()
Return a fragment info non-empty domain variable from name
tiledb_fragment_info_get_num()
Return a fragment info number of fragments
tiledb_fragment_info_get_size()
Return a fragment info fragment size for a given fragment index
tiledb_fragment_info_get_timestamp_range()
Return a fragment info timestamp range for a given fragment index
tiledb_fragment_info_get_to_vacuum_num()
Return the number of fragment info elements to be vacuumed
tiledb_fragment_info_get_to_vacuum_uri()
Return fragment info URI of the to be vacuumed index
tiledb_fragment_info_get_unconsolidated_metadata_num()
Return fragment info number of unconsolidated metadata
tiledb_fragment_info_get_version()
Return a fragment info version for a given fragment index
tiledb_fragment_info_has_consolidated_metadata()
Return if a fragment info index has consolidated metadata
tiledb_fragment_info_sparse()
Return if a fragment info index is sparse
tiledb_fragment_info_uri()
Return a fragment info URI given its index

DataFrame

data.frame functionality functions

SparseMatrix

matrix and sparse matrices helper functions

fromMatrix() toMatrix()
Create a TileDB array from an R matrix, or return an R matrix
fromSparseMatrix() toSparseMatrix()
Create (or return) a TileDB sparse array

Arrow

interface to Arrow in-memory representation

Package

package and version information

tiledb_version()
The version of the libtiledb library
limitTileDBCores()
Limit TileDB core use to a given number of cores

Enumeration

support for factor and ordered

tiledb_array_has_enumeration()
Check for Enumeration (aka Factor aka Dictionary)
tiledb_array_schema_evolution_add_enumeration()
Add an Enumeration to a TileDB Array Schema Evolution object
tiledb_array_schema_evolution_add_enumeration_empty()
Evolve an Array Schema by adding an empty Enumeration
tiledb_array_schema_evolution_drop_enumeration()
Drop an Enumeration given by name from a TileDB Array Schema Evolution object
tiledb_array_schema_evolution_extend_enumeration()
Extend an Evolution via Array Schema Evolution
tiledb_array_schema_set_enumeration_empty()
Add an empty Enumeration to a Schema
tiledb_attribute_get_enumeration() tiledb_attribute_get_enumeration_ptr()
Get the TileDB Attribute Enumeration
tiledb_attribute_has_enumeration()
Test if TileDB Attribute has an Enumeration
tiledb_attribute_is_ordered_enumeration_ptr()
Check if TileDB Attribute Enumeration is Ordered
tiledb_attribute_set_enumeration_name()
Set a TileDB Attribute Enumeration Name
tiledb_query_condition_set_use_enumeration()
Enable use of enumeration in query condition
tiledb_schema_get_enumeration_status()
Get Dimension or Attribute Status