TileDB-Inc/TileDB-Cloud-R
TileDB Cloud Platform R Client Package

Package index
Search the TileDB-Inc/TileDB-Cloud-R package
Vignettes
Functions
256
Source code
311
Man pages
183
Home
/
GitHub
/
TileDB-Inc/TileDB-Cloud-R
/
ArrayApi: Array operations

ArrayApi: Array operations
In TileDB-Inc/TileDB-Cloud-R: TileDB Cloud Platform R Client Package

ArrayApiR Documentation

Array operations

Description

tiledbcloud.Array

Format

An R6Class generator object

Methods

ArrayActivityLog get array activity logs

  • @param namespace character

  • @param array character

  • @param start integer

  • @param end integer

  • @param event.types character

  • @param task.id character

  • @param has.task.id character

  • @returnType list( ArrayActivityLog )

  • status code : 200 | log of array activity

  • return type : array[ArrayActivityLog]

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

ArraysBrowserOwnedGet Fetch a list of all arrays that are owned directly by user or user's organizations

  • @param page integer

  • @param per.page integer

  • @param search character

  • @param namespace character

  • @param orderby character

  • @param permissions character

  • @param tag list( character )

  • @param exclude.tag list( character )

  • @param file.type list( character )

  • @param exclude.file.type list( character )

  • @param file.property list( character )

  • @returnType ArrayBrowserData

  • status code : 200 | Array of array info that are owned directly by user or user's organizations

  • return type : ArrayBrowserData

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

ArraysBrowserOwnedSidebarGet Fetch a sidebar for arrays that are owned directly by user or user's organizations

  • @returnType ArrayBrowserSidebar

  • status code : 200 | Array of array info that are owned directly by user or user's organizations

  • return type : ArrayBrowserSidebar

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

ArraysBrowserPublicGet Fetch a list of all arrays that have been shared publically

  • @param page integer

  • @param per.page integer

  • @param search character

  • @param namespace character

  • @param orderby character

  • @param permissions character

  • @param tag list( character )

  • @param exclude.tag list( character )

  • @param file.type list( character )

  • @param exclude.file.type list( character )

  • @param file.property list( character )

  • @returnType ArrayBrowserData

  • status code : 200 | Array of array info that has been shared publically

  • return type : ArrayBrowserData

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

ArraysBrowserPublicSidebarGet Fetch a sidebar of all arrays that have been shared publically

  • @returnType ArrayBrowserSidebar

  • status code : 200 | Array of array info that has been shared publically

  • return type : ArrayBrowserSidebar

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

ArraysBrowserSharedGet Fetch a list of all arrays that have been shared with the user

  • @param page integer

  • @param per.page integer

  • @param search character

  • @param namespace character

  • @param orderby character

  • @param permissions character

  • @param tag list( character )

  • @param exclude.tag list( character )

  • @param file.type list( character )

  • @param exclude.file.type list( character )

  • @param file.property list( character )

  • @returnType ArrayBrowserData

  • status code : 200 | Array of array info that has been shared with the user

  • return type : ArrayBrowserData

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

ArraysBrowserSharedSidebarGet Fetch a list of all arrays that have been shared with the user

  • @returnType ArrayBrowserSidebar

  • status code : 200 | Array of array info that has been shared with the user

  • return type : ArrayBrowserSidebar

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

ArraysNamespaceArrayEndTimestampsGet retrieve a list of timestamps from the array fragment info listing in milliseconds, paginated

  • @param namespace character

  • @param array character

  • @param page integer

  • @param per.page integer

  • @returnType ArrayEndTimestampData

  • status code : 200 | list of timestamps in milliseconds, paginated

  • return type : ArrayEndTimestampData

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

ConsolidateArray consolidate an array at a specified URI

  • @param namespace character

  • @param array character

  • @param tiledb.config TileDBConfig

  • status code : 204 | array consolidated successfully

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

CreateArray create a array schema at a specified URI registered to a group/project

  • @param namespace character

  • @param array character

  • @param content.type character

  • @param array.schema ArraySchema

  • @param X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME character

  • status code : 204 | schema created successfully

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

DeleteArray delete a array

  • @param namespace character

  • @param array character

  • @param content.type character

  • status code : 204 | delete array successful

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

DeregisterArray deregister a array

  • @param namespace character

  • @param array character

  • status code : 204 | deregistered array successful

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetActivityLogById get activity log by ID

  • @param namespace character

  • @param array character

  • @param id character

  • @returnType ArrayActivityLog

  • status code : 200 | array activity

  • return type : ArrayActivityLog

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetAllArrayMetadata get all array metadata user has access to

  • @param public.share character

  • @returnType list( ArrayInfo )

  • status code : 200 | array metadata for all arrays user has access to

  • return type : array[ArrayInfo]

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetArray get an ArraySchema using a url encoded uri

  • @param namespace character

  • @param array character

  • @param content.type character

  • @returnType ArraySchema

  • status code : 200 | get ArraySchema

  • return type : ArraySchema

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetArrayMaxBufferSizes get the max buffer sizes of an array for a subarray

  • @param namespace character

  • @param array character

  • @param subarray character

  • @param content.type character

  • @param x.payer character

  • @returnType MaxBufferSizes

  • status code : 200 | get the max buffer sizes of an array for a subarray

  • return type : MaxBufferSizes

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetArrayMetaDataJson get metadata from the array in JSON format

  • @param namespace character

  • @param array character

  • @param length integer

  • @param end.timestamp integer

  • status code : 200 | get array metadata

  • return type : object

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetArrayMetadata get metadata on an array

  • @param namespace character

  • @param array character

  • @returnType ArrayInfo

  • status code : 200 | array metadata for an array

  • return type : ArrayInfo

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetArrayMetadataCapnp get metadata on an array

  • @param namespace character

  • @param array character

  • @returnType ArrayMetadata

  • status code : 200 | array metadata for an array

  • return type : ArrayMetadata

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetArrayNonEmptyDomain get the non empty domain of an array

  • @param namespace character

  • @param array character

  • @param content.type character

  • @param x.payer character

  • @returnType NonEmptyDomain

  • status code : 200 | get the non empty domain of an array

  • return type : NonEmptyDomain

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetArrayNonEmptyDomainJson get non-empty domain from the array in json format

  • @param namespace character

  • @param array character

  • status code : 200 | get array non-empty domaim

  • return type : object

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetArraySampleData get an sample set of data from the array

  • @param namespace character

  • @param array character

  • @param samples numeric

  • @returnType ArraySample

  • status code : 200 | get array sample data

  • return type : ArraySample

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetArraySharingPolicies Get all sharing details of the array

  • @param namespace character

  • @param array character

  • @returnType list( ArraySharing )

  • status code : 200 | List of all specific sharing policies

  • return type : array[ArraySharing]

  • response headers :

  • status code : 404 | Array does not exist or user does not have permissions to view array-sharing policies

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetArraysInNamespace get metadata on all arrays in a namespace

  • @param namespace character

  • @returnType list( ArrayInfo )

  • status code : 200 | array metadata for all arrays in a namespace

  • return type : array[ArrayInfo]

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetFragmentEndTimestamp Get fragment end_timestamp on an array, will search for the closest end_timestamp to the timestamp asked

  • @param namespace character

  • @param array character

  • @param end.timestamp integer

  • status code : 200 | fragment end_timestamp on an array

  • return type : integer

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

GetLastAccessedArrays

  • @returnType list( LastAccessedArray )

  • status code : 200 | gets last accessed arrays

  • return type : array[LastAccessedArray]

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

RegisterArray register an array at a specified URI registered to the given namespace

  • @param namespace character

  • @param array character

  • @param array.metadata ArrayInfoUpdate

  • status code : 204 | schema registered successfully

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

ShareArray Share an array with a user

  • @param namespace character

  • @param array character

  • @param array.sharing ArraySharing

  • status code : 204 | Array shared successfully

  • response headers :

  • status code : 404 | Array does not exist or user does not have permissions to share array

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

UpdateArrayMetadata update metadata on an array

  • @param namespace character

  • @param array character

  • @param array.metadata ArrayInfoUpdate

  • status code : 204 | array metadata updated successfully

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

UpdateArrayMetadataCapnp update metadata on an array

  • @param namespace character

  • @param array character

  • @param array.metadata.entries ArrayMetadata

  • status code : 200 | array metadata updated successfully

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

VacuumArray vacuum an array at a specified URI

  • @param namespace character

  • @param array character

  • @param tiledb.config TileDBConfig

  • status code : 204 | array vacuumed successfully

  • response headers :

  • status code : 0 | error response

  • return type : Error

  • response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

Method new()

Usage
ArrayApi$new(apiClient)

Method ArrayActivityLog()

Usage
ArrayApi$ArrayActivityLog(
  namespace,
  array,
  start = NULL,
  end = NULL,
  event.types = NULL,
  task.id = NULL,
  has.task.id = NULL,
  ...
)

Method ArrayActivityLogWithHttpInfo()

Usage
ArrayApi$ArrayActivityLogWithHttpInfo(
  namespace,
  array,
  start = NULL,
  end = NULL,
  event.types = NULL,
  task.id = NULL,
  has.task.id = NULL,
  ...
)

Method ArraysBrowserOwnedGet()

Usage
ArrayApi$ArraysBrowserOwnedGet(
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  file.property = NULL,
  ...
)

Method ArraysBrowserOwnedGetWithHttpInfo()

Usage
ArrayApi$ArraysBrowserOwnedGetWithHttpInfo(
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  file.property = NULL,
  ...
)

Method ArraysBrowserOwnedSidebarGet()

Usage
ArrayApi$ArraysBrowserOwnedSidebarGet(...)

Method ArraysBrowserOwnedSidebarGetWithHttpInfo()

Usage
ArrayApi$ArraysBrowserOwnedSidebarGetWithHttpInfo(...)

Method ArraysBrowserPublicGet()

Usage
ArrayApi$ArraysBrowserPublicGet(
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  file.property = NULL,
  ...
)

Method ArraysBrowserPublicGetWithHttpInfo()

Usage
ArrayApi$ArraysBrowserPublicGetWithHttpInfo(
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  file.property = NULL,
  ...
)

Method ArraysBrowserPublicSidebarGet()

Usage
ArrayApi$ArraysBrowserPublicSidebarGet(...)

Method ArraysBrowserPublicSidebarGetWithHttpInfo()

Usage
ArrayApi$ArraysBrowserPublicSidebarGetWithHttpInfo(...)

Method ArraysBrowserSharedGet()

Usage
ArrayApi$ArraysBrowserSharedGet(
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  file.property = NULL,
  ...
)

Method ArraysBrowserSharedGetWithHttpInfo()

Usage
ArrayApi$ArraysBrowserSharedGetWithHttpInfo(
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  file.type = NULL,
  exclude.file.type = NULL,
  file.property = NULL,
  ...
)

Method ArraysBrowserSharedSidebarGet()

Usage
ArrayApi$ArraysBrowserSharedSidebarGet(...)

Method ArraysBrowserSharedSidebarGetWithHttpInfo()

Usage
ArrayApi$ArraysBrowserSharedSidebarGetWithHttpInfo(...)

Method ArraysNamespaceArrayEndTimestampsGet()

Usage
ArrayApi$ArraysNamespaceArrayEndTimestampsGet(
  namespace,
  array,
  page = NULL,
  per.page = NULL,
  ...
)

Method ArraysNamespaceArrayEndTimestampsGetWithHttpInfo()

Usage
ArrayApi$ArraysNamespaceArrayEndTimestampsGetWithHttpInfo(
  namespace,
  array,
  page = NULL,
  per.page = NULL,
  ...
)

Method ConsolidateArray()

Usage
ArrayApi$ConsolidateArray(namespace, array, tiledb.config, ...)

Method ConsolidateArrayWithHttpInfo()

Usage
ArrayApi$ConsolidateArrayWithHttpInfo(namespace, array, tiledb.config, ...)

Method CreateArray()

Usage
ArrayApi$CreateArray(
  namespace,
  array,
  content.type,
  array.schema,
  X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = NULL,
  ...
)

Method CreateArrayWithHttpInfo()

Usage
ArrayApi$CreateArrayWithHttpInfo(
  namespace,
  array,
  content.type,
  array.schema,
  X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME = NULL,
  ...
)

Method DeleteArray()

Usage
ArrayApi$DeleteArray(namespace, array, content.type, ...)

Method DeleteArrayWithHttpInfo()

Usage
ArrayApi$DeleteArrayWithHttpInfo(namespace, array, content.type, ...)

Method DeregisterArray()

Usage
ArrayApi$DeregisterArray(namespace, array, ...)

Method DeregisterArrayWithHttpInfo()

Usage
ArrayApi$DeregisterArrayWithHttpInfo(namespace, array, ...)

Method GetActivityLogById()

Usage
ArrayApi$GetActivityLogById(namespace, array, id, ...)

Method GetActivityLogByIdWithHttpInfo()

Usage
ArrayApi$GetActivityLogByIdWithHttpInfo(namespace, array, id, ...)

Method GetAllArrayMetadata()

Usage
ArrayApi$GetAllArrayMetadata(public.share = NULL, ...)

Method GetAllArrayMetadataWithHttpInfo()

Usage
ArrayApi$GetAllArrayMetadataWithHttpInfo(public.share = NULL, ...)

Method GetArray()

Usage
ArrayApi$GetArray(namespace, array, content.type, ...)

Method GetArrayWithHttpInfo()

Usage
ArrayApi$GetArrayWithHttpInfo(namespace, array, content.type, ...)

Method GetArrayMaxBufferSizes()

Usage
ArrayApi$GetArrayMaxBufferSizes(
  namespace,
  array,
  subarray,
  content.type,
  x.payer = NULL,
  ...
)

Method GetArrayMaxBufferSizesWithHttpInfo()

Usage
ArrayApi$GetArrayMaxBufferSizesWithHttpInfo(
  namespace,
  array,
  subarray,
  content.type,
  x.payer = NULL,
  ...
)

Method GetArrayMetaDataJson()

Usage
ArrayApi$GetArrayMetaDataJson(
  namespace,
  array,
  length = NULL,
  end.timestamp = NULL,
  ...
)

Method GetArrayMetaDataJsonWithHttpInfo()

Usage
ArrayApi$GetArrayMetaDataJsonWithHttpInfo(
  namespace,
  array,
  length = NULL,
  end.timestamp = NULL,
  ...
)

Method GetArrayMetadata()

Usage
ArrayApi$GetArrayMetadata(namespace, array, ...)

Method GetArrayMetadataWithHttpInfo()

Usage
ArrayApi$GetArrayMetadataWithHttpInfo(namespace, array, ...)

Method GetArrayMetadataCapnp()

Usage
ArrayApi$GetArrayMetadataCapnp(namespace, array, ...)

Method GetArrayMetadataCapnpWithHttpInfo()

Usage
ArrayApi$GetArrayMetadataCapnpWithHttpInfo(namespace, array, ...)

Method GetArrayNonEmptyDomain()

Usage
ArrayApi$GetArrayNonEmptyDomain(
  namespace,
  array,
  content.type,
  x.payer = NULL,
  ...
)

Method GetArrayNonEmptyDomainWithHttpInfo()

Usage
ArrayApi$GetArrayNonEmptyDomainWithHttpInfo(
  namespace,
  array,
  content.type,
  x.payer = NULL,
  ...
)

Method GetArrayNonEmptyDomainJson()

Usage
ArrayApi$GetArrayNonEmptyDomainJson(namespace, array, ...)

Method GetArrayNonEmptyDomainJsonWithHttpInfo()

Usage
ArrayApi$GetArrayNonEmptyDomainJsonWithHttpInfo(namespace, array, ...)

Method GetArraySampleData()

Usage
ArrayApi$GetArraySampleData(namespace, array, samples = 5, ...)

Method GetArraySampleDataWithHttpInfo()

Usage
ArrayApi$GetArraySampleDataWithHttpInfo(namespace, array, samples = 5, ...)

Method GetArraySharingPolicies()

Usage
ArrayApi$GetArraySharingPolicies(namespace, array, ...)

Method GetArraySharingPoliciesWithHttpInfo()

Usage
ArrayApi$GetArraySharingPoliciesWithHttpInfo(namespace, array, ...)

Method GetArraysInNamespace()

Usage
ArrayApi$GetArraysInNamespace(namespace, ...)

Method GetArraysInNamespaceWithHttpInfo()

Usage
ArrayApi$GetArraysInNamespaceWithHttpInfo(namespace, ...)

Method GetFragmentEndTimestamp()

Usage
ArrayApi$GetFragmentEndTimestamp(namespace, array, end.timestamp = NULL, ...)

Method GetFragmentEndTimestampWithHttpInfo()

Usage
ArrayApi$GetFragmentEndTimestampWithHttpInfo(
  namespace,
  array,
  end.timestamp = NULL,
  ...
)

Method GetLastAccessedArrays()

Usage
ArrayApi$GetLastAccessedArrays(...)

Method GetLastAccessedArraysWithHttpInfo()

Usage
ArrayApi$GetLastAccessedArraysWithHttpInfo(...)

Method RegisterArray()

Usage
ArrayApi$RegisterArray(namespace, array, array.metadata, ...)

Method RegisterArrayWithHttpInfo()

Usage
ArrayApi$RegisterArrayWithHttpInfo(namespace, array, array.metadata, ...)

Method ShareArray()

Usage
ArrayApi$ShareArray(namespace, array, array.sharing, ...)

Method ShareArrayWithHttpInfo()

Usage
ArrayApi$ShareArrayWithHttpInfo(namespace, array, array.sharing, ...)

Method UpdateArrayMetadata()

Usage
ArrayApi$UpdateArrayMetadata(namespace, array, array.metadata, ...)

Method UpdateArrayMetadataWithHttpInfo()

Usage
ArrayApi$UpdateArrayMetadataWithHttpInfo(namespace, array, array.metadata, ...)

Method UpdateArrayMetadataCapnp()

Usage
ArrayApi$UpdateArrayMetadataCapnp(
  namespace,
  array,
  array.metadata.entries,
  ...
)

Method UpdateArrayMetadataCapnpWithHttpInfo()

Usage
ArrayApi$UpdateArrayMetadataCapnpWithHttpInfo(
  namespace,
  array,
  array.metadata.entries,
  ...
)

Method VacuumArray()

Usage
ArrayApi$VacuumArray(namespace, array, tiledb.config, ...)

Method VacuumArrayWithHttpInfo()

Usage
ArrayApi$VacuumArrayWithHttpInfo(namespace, array, tiledb.config, ...)

Method clone()

The objects of this class are cloneable with this method.

Usage
ArrayApi$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

## Not run: 
####################  ArrayActivityLog  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.start <- 56 # integer | Start time of window of fetch logs, unix epoch in seconds (default: seven days ago)
var.end <- 56 # integer | End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp)
var.event.types <- 'event.types_example' # character | Event values can be one or more of the following read, write, create, delete, register, deregister, comma separated
var.task.id <- 'task.id_example' # character | Array task ID To filter activity to
var.has.task.id <- 'has.task.id_example' # character | Excludes activity log results that do not contain an array task UUID

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ArrayActivityLog(var.namespace, var.array, start=var.start, end=var.end, event.types=var.event.types, task.id=var.task.id, has.task.id=var.has.task.id)


####################  ArraysBrowserOwnedGet  ####################

library(tiledbcloud)
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.namespace <- 'namespace_example' # character | namespace
var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name
var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin
var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included
var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included
var.file.type <- ['file.type_example'] # array[character] | file_type to search for, more than one can be included
var.exclude.file.type <- ['exclude.file.type_example'] # array[character] | file_type to exclude matching array in results, more than one can be included
var.file.property <- ['file.property_example'] # array[character] | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ArraysBrowserOwnedGet(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, file.type=var.file.type, exclude.file.type=var.exclude.file.type, file.property=var.file.property)


####################  ArraysBrowserOwnedSidebarGet  ####################

library(tiledbcloud)

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ArraysBrowserOwnedSidebarGet()


####################  ArraysBrowserPublicGet  ####################

library(tiledbcloud)
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.namespace <- 'namespace_example' # character | namespace
var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name
var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin
var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included
var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included
var.file.type <- ['file.type_example'] # array[character] | file_type to search for, more than one can be included
var.exclude.file.type <- ['exclude.file.type_example'] # array[character] | file_type to exclude matching array in results, more than one can be included
var.file.property <- ['file.property_example'] # array[character] | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ArraysBrowserPublicGet(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, file.type=var.file.type, exclude.file.type=var.exclude.file.type, file.property=var.file.property)


####################  ArraysBrowserPublicSidebarGet  ####################

library(tiledbcloud)

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ArraysBrowserPublicSidebarGet()


####################  ArraysBrowserSharedGet  ####################

library(tiledbcloud)
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.namespace <- 'namespace_example' # character | namespace
var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name
var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin
var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included
var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included
var.file.type <- ['file.type_example'] # array[character] | file_type to search for, more than one can be included
var.exclude.file.type <- ['exclude.file.type_example'] # array[character] | file_type to exclude matching array in results, more than one can be included
var.file.property <- ['file.property_example'] # array[character] | file_property key-value pair (comma separated, i.e. key,value) to search for, more than one can be included

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ArraysBrowserSharedGet(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, file.type=var.file.type, exclude.file.type=var.exclude.file.type, file.property=var.file.property)


####################  ArraysBrowserSharedSidebarGet  ####################

library(tiledbcloud)

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ArraysBrowserSharedSidebarGet()


####################  ArraysNamespaceArrayEndTimestampsGet  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ArraysNamespaceArrayEndTimestampsGet(var.namespace, var.array, page=var.page, per.page=var.per.page)


####################  ConsolidateArray  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.tiledb.config <- TileDBConfig$new() # TileDBConfig | tiledb configuration

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ConsolidateArray(var.namespace, var.array, var.tiledb.config)


####################  CreateArray  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.content.type <- 'application/json' # character | Content Type of input and return mime
var.array.schema <- ArraySchema$new() # ArraySchema | ArraySchema being created
var.X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME <- 'X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME_example' # character | Optional registered access credentials to use for creation

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$CreateArray(var.namespace, var.array, var.content.type, var.array.schema, X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME=var.X_TILEDB_CLOUD_ACCESS_CREDENTIALS_NAME)


####################  DeleteArray  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.content.type <- 'application/json' # character | Content Type of input and return mime

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$DeleteArray(var.namespace, var.array, var.content.type)


####################  DeregisterArray  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$DeregisterArray(var.namespace, var.array)


####################  GetActivityLogById  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.id <- 'id_example' # character | ID of the activity

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetActivityLogById(var.namespace, var.array, var.id)


####################  GetAllArrayMetadata  ####################

library(tiledbcloud)
var.public.share <- 'public.share_example' # character | Public share values can be one of exclude, only

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetAllArrayMetadata(public.share=var.public.share)


####################  GetArray  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.content.type <- 'application/json' # character | Content Type of input and return mime

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetArray(var.namespace, var.array, var.content.type)


####################  GetArrayMaxBufferSizes  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.subarray <- 'subarray_example' # character | CSV string of subarray to get max buffer sizes for
var.content.type <- 'application/json' # character | Content Type of input and return mime
var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetArrayMaxBufferSizes(var.namespace, var.array, var.subarray, var.content.type, x.payer=var.x.payer)


####################  GetArrayMetaDataJson  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.length <- 56 # integer | (optional) limit character length of returned values
var.end.timestamp <- 56 # integer | Milliseconds since Unix epoch, metadata will use open_at functionality to open array at the specific timestamp

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetArrayMetaDataJson(var.namespace, var.array, length=var.length, end.timestamp=var.end.timestamp)


####################  GetArrayMetadata  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetArrayMetadata(var.namespace, var.array)


####################  GetArrayMetadataCapnp  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetArrayMetadataCapnp(var.namespace, var.array)


####################  GetArrayNonEmptyDomain  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.content.type <- 'application/json' # character | Content Type of input and return mime
var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetArrayNonEmptyDomain(var.namespace, var.array, var.content.type, x.payer=var.x.payer)


####################  GetArrayNonEmptyDomainJson  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetArrayNonEmptyDomainJson(var.namespace, var.array)


####################  GetArraySampleData  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.samples <- 5.0 # numeric | Number of sample results to return

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetArraySampleData(var.namespace, var.array, samples=var.samples)


####################  GetArraySharingPolicies  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetArraySharingPolicies(var.namespace, var.array)


####################  GetArraysInNamespace  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetArraysInNamespace(var.namespace)


####################  GetFragmentEndTimestamp  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.end.timestamp <- 56 # integer | Milliseconds since Unix epoch

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetFragmentEndTimestamp(var.namespace, var.array, end.timestamp=var.end.timestamp)


####################  GetLastAccessedArrays  ####################

library(tiledbcloud)

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$GetLastAccessedArrays()


####################  RegisterArray  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.array.metadata <- ArrayInfoUpdate$new() # ArrayInfoUpdate | metadata associated with array

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$RegisterArray(var.namespace, var.array, var.array.metadata)


####################  ShareArray  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.array.sharing <- ArraySharing$new() # ArraySharing | Namespace and list of permissions to share with. An empty list of permissions will remove the namespace; if permissions already exist they will be deleted then new ones added. In the event of a failure, the new policies will be rolled back to prevent partial policies, and it's likely the array will not be shared with the namespace at all.

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$ShareArray(var.namespace, var.array, var.array.sharing)


####################  UpdateArrayMetadata  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.array.metadata <- ArrayInfoUpdate$new() # ArrayInfoUpdate | array metadata to update

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$UpdateArrayMetadata(var.namespace, var.array, var.array.metadata)


####################  UpdateArrayMetadataCapnp  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.array.metadata.entries <- ArrayMetadata$new() # ArrayMetadata | List of metadata entries

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$UpdateArrayMetadataCapnp(var.namespace, var.array, var.array.metadata.entries)


####################  VacuumArray  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.tiledb.config <- TileDBConfig$new() # TileDBConfig | tiledb configuration

api.instance <- ArrayApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$VacuumArray(var.namespace, var.array, var.tiledb.config)



## End(Not run)

TileDB-Inc/TileDB-Cloud-R documentation built on July 18, 2024, 3:33 p.m.

Related to ArrayApi in TileDB-Inc/TileDB-Cloud-R...

TileDB-Inc/TileDB-Cloud-R index
README.md

R Package Documentation

rdrr.io home R language documentation Run R code online

Browse R Packages

CRAN packages Bioconductor packages R-Forge packages GitHub packages

We want your feedback!

Note that we can't provide technical support on individual packages. You should contact the package authors for that.
GitHub issue tracker
ian@mutexlabs.com
Personal blog

 
Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.

Close