diff --git a/R/Array.R b/R/Array.R index db7417aff1..debcada0ee 100644 --- a/R/Array.R +++ b/R/Array.R @@ -25,7 +25,7 @@ #' @param uri URI specifying path to create the TileDB array object #' @param schema tiledb_array_schema object #' @param encryption_key optional A character value with an AES-256 encryption key -#' in case the array should be encryption. +#' in case the array should be encrypted. #' #' @examples #' \dontshow{ @@ -181,9 +181,9 @@ tiledb_array_is_heterogeneous <- function(arr) { ##' @return A boolean indicating success ##' @export tiledb_array_delete_fragments <- function( - arr, - ts_start, - ts_end, + arr, + ts_start, + ts_end, ctx = tiledb_get_context() ) { stopifnot( @@ -197,15 +197,15 @@ tiledb_array_delete_fragments <- function( ##' Delete fragments written given by their URIs ##' -##' @param arr A TileDB Array object as for example returned by +##' @param arr A TileDB Array object as for example returned by ##' \code{tiledb_array()} ##' @param fragments A character vector with fragment URIs ##' @param ctx A tiledb_ctx object (optional) ##' @return A boolean indicating success ##' @export tiledb_array_delete_fragments_list <- function( - arr, - fragments, + arr, + fragments, ctx = tiledb_get_context() ) { stopifnot( @@ -247,7 +247,7 @@ tiledb_array_has_enumeration <- function(arr) { ##' @return The value of the aggregation ##' @export tiledb_array_apply_aggregate <- function( - array, + array, attrname, operation = c("Count", "NullCount", "Min", "Max", "Mean", "Sum"), nullable = TRUE @@ -283,8 +283,8 @@ tiledb_array_apply_aggregate <- function( ##' @return Nothing is returned as the function is invoked for its side effect ##' @export tiledb_array_upgrade_version <- function( - array, - config = NULL, + array, + config = NULL, ctx = tiledb_get_context() ) { stopifnot( diff --git a/R/ArraySchema.R b/R/ArraySchema.R index 173a8fef17..d0f6854dc5 100644 --- a/R/ArraySchema.R +++ b/R/ArraySchema.R @@ -53,6 +53,8 @@ tiledb_array_schema.from_ptr <- function(ptr, arrptr = NULL) { #' @param allows_dups (optional, requires \sQuote{sparse} to be TRUE) #' @param enumerations (optional) named list of enumerations #' @param ctx tiledb_ctx object (optional) +#' +#' @return An object of class `tiledb_array_schema`. #' @examples #' \dontshow{ #' ctx <- tiledb_ctx(limitTileDBCores()) @@ -154,7 +156,7 @@ tiledb_array_schema.from_array <- function(x, ctx = tiledb_get_context()) { #' This method used the display method provided by the underlying #' library. #' -#' @param object An array_schema object +#' @param object A TileDB Schema object #' @export setMethod("raw_dump", signature(object = "tiledb_array_schema"), @@ -163,7 +165,7 @@ setMethod("raw_dump", #' Prints an array schema object #' -#' @param object An array_schema object +#' @param object A TileDB Schema object #' @export setMethod("show", signature(object = "tiledb_array_schema"), definition = function(object) { @@ -194,7 +196,8 @@ setGeneric("domain", function(object, ...) standardGeneric("domain")) #' Returns the `tiledb_domain` object associated with a given `tiledb_array_schema` #' -#' @param object tiledb_array_schema +#' @param object A TileDB Schema object +#' @return A `tiledb_domain` object #' @examples #' \dontshow{ #' ctx <- tiledb_ctx(limitTileDBCores()) @@ -218,8 +221,8 @@ setGeneric("dimensions", function(object, ...) standardGeneric("dimensions")) #' Returns a list of `tiledb_dim` objects associated with the `tiledb_array_schema` #' -#' @param object tiledb_array_schema -#' @return a list of tiledb_dim objects +#' @param object A TileDB Schema object +#' @return A list of `tiledb_dim` objects #' @examples #' \dontshow{ #' ctx <- tiledb_ctx(limitTileDBCores()) @@ -245,10 +248,10 @@ setGeneric("attrs", function(object, idx, ...) standardGeneric("attrs")) #' Returns a list of all `tiledb_attr` objects associated with the `tiledb_array_schema` #' -#' @param object tiledb_array_schema +#' @param object A TileDB Schema object #' @param idx index argument, currently unused. #' @param ... Extra parameter for method signature, currently unused. -#' @return a list of tiledb_attr objects +#' @return A list of `tiledb_attr` objects #' @examples #' \dontshow{ #' ctx <- tiledb_ctx(limitTileDBCores()) @@ -278,10 +281,10 @@ setMethod( #' Returns a `tiledb_attr` object associated with the `tiledb_array_schema` with a given name. #' -#' @param object tiledb_array_schema +#' @param object A TileDB Schema object #' @param idx attribute name string #' @param ... Extra parameter for method signature, currently unused. -#' @return a `tiledb_attr` object +#' @return A `tiledb_attr` object #' @examples #' \dontshow{ #' ctx <- tiledb_ctx(limitTileDBCores()) @@ -306,10 +309,10 @@ setMethod( #' #' The attribute index is defined by the order the attributes were defined in the schema #' -#' @param object tiledb_array_schema +#' @param object A TileDB Schema object #' @param idx attribute index #' @param ... Extra parameter for method signature, currently unused. -#' @return a `tiledb_attr` object +#' @return A `tiledb_attr` object #' @examples #' \dontshow{ #' ctx <- tiledb_ctx(limitTileDBCores()) @@ -335,7 +338,8 @@ setMethod( setGeneric("cell_order", function(object, ...) standardGeneric("cell_order")) #' Returns the cell layout string associated with the `tiledb_array_schema` -#' @param object tiledb object +#' @param object A TileDB Schema object +#' @return A character string with cell's layout, e.g., `"COL_MAJOR"`. #' @export setMethod( "cell_order", "tiledb_array_schema", @@ -349,7 +353,8 @@ setMethod( setGeneric("tile_order", function(object, ...) standardGeneric("tile_order")) #' Returns the tile layout string associated with the `tiledb_array_schema` -#' @param object tiledb object +#' @param object A TileDB Schema object +#' @return A character string with tile's layout, e.g., `"COL_MAJOR"`. #' @export setMethod( "tile_order", "tiledb_array_schema", @@ -377,8 +382,8 @@ setGeneric("filter_list<-", function(x, value) standardGeneric("filter_list<-")) #' Returns the offsets and coordinate filter_lists associated with the `tiledb_array_schema` #' -#' @param object tiledb_array_schema -#' @return a list of tiledb_filter_list objects +#' @param object A TileDB Schema object +#' @return A list of `tiledb_filter_list` objects #' @export setMethod("filter_list", "tiledb_array_schema", function(object) { coords_ptr <- libtiledb_array_schema_get_coords_filter_list(object@ptr) @@ -405,9 +410,9 @@ setMethod("filter_list", "tiledb_array_schema", function(object) { #' Set a Filter List for Coordinate of a TileDB Schema #' -#' @param sch A TileDB Array Schema object +#' @param sch A TileDB Schema object #' @param fl A TileDB Filter List object -#' @return The modified Array Schema object +#' @return The modified `tiledb_array_schema` object. #' @export tiledb_array_schema_set_coords_filter_list <- function(sch, fl) { stopifnot( @@ -420,9 +425,9 @@ tiledb_array_schema_set_coords_filter_list <- function(sch, fl) { #' Set a Filter List for Variable-Sized Offsets of a TileDB Schema #' -#' @param sch A TileDB Array Schema object +#' @param sch A TileDB Schema object #' @param fl A TileDB Filter List object -#' @return The modified Array Schema object +#' @return The modified `tiledb_array_schema` object. #' @export tiledb_array_schema_set_offsets_filter_list <- function(sch, fl) { stopifnot( @@ -435,9 +440,9 @@ tiledb_array_schema_set_offsets_filter_list <- function(sch, fl) { #' Set a Filter List for Validity of a TileDB Schema #' -#' @param sch A TileDB Array Schema object +#' @param sch A TileDB Schema object #' @param fl A TileDB Filter List object -#' @return The modified Array Schema object +#' @return The modified `tiledb_array_schema` object. #' @export tiledb_array_schema_set_validity_filter_list <- function(sch, fl) { stopifnot( @@ -454,8 +459,8 @@ setGeneric("is.sparse", function(object, ...) standardGeneric("is.sparse")) #' Returns TRUE if the tiledb_array_schema is sparse, else FALSE #' -#' @param object tiledb_array_schema -#' @return TRUE if tiledb_array_schema is sparse +#' @param object A TileDB Schema object +#' @return `TRUE` if `tiledb_array_schema` object is sparse #' @export setMethod( "is.sparse", "tiledb_array_schema", @@ -470,7 +475,7 @@ setGeneric("tiledb_ndim", function(object, ...) standardGeneric("tiledb_ndim")) #' Return the number of dimensions associated with the `tiledb_array_schema` #' -#' @param object tiledb_array_schema +#' @param object A TileDB Schema object #' @return integer number of dimensions #' @examples #' \dontshow{ @@ -496,7 +501,7 @@ setMethod( #' #' Only valid for integral (integer) domains #' -#' @param x tiledb_array_schema +#' @param x A TileDB Schema object #' @return a dimension vector #' @examples #' \dontshow{ @@ -536,8 +541,8 @@ setMethod("allows_dups", signature = "tiledb_array_schema", function(x) { #' Returns logical value whether the array schema allows duplicate values or not. #' This is only valid for sparse arrays. #' -#' @param x tiledb_array_schema -#' @return the logical value +#' @param x A TileDB Schema object +#' @return A logical value. #' @export tiledb_array_schema_get_allows_dups <- function(x) { stopifnot(`The 'x' argument must be a tiledb_array_schema object` = is(x, "tiledb_array_schema")) @@ -551,8 +556,8 @@ setGeneric("allows_dups<-", function(x, value) standardGeneric("allows_dups<-")) #' @rdname tiledb_array_schema_set_allows_dups #' @export setMethod( - "allows_dups<-", - signature = "tiledb_array_schema", + "allows_dups<-", + signature = "tiledb_array_schema", definition = function(x, value) { libtiledb_array_schema_set_allows_dups(x@ptr, value) x @@ -562,9 +567,9 @@ setMethod( #' Sets toggle whether the array schema allows duplicate values or not. #' This is only valid for sparse arrays. #' -#' @param x tiledb_array_schema +#' @param x A TileDB Schema object #' @param value logical value -#' @return the tiledb_array_schema object +#' @return An object of class `tiledb_array_schema`. #' @export tiledb_array_schema_set_allows_dups <- function(x, value) { stopifnot( @@ -666,7 +671,7 @@ setMethod("capacity", signature = "tiledb_array_schema", function(object) { #' @export setReplaceMethod( "capacity", - signature = "tiledb_array_schema", + signature = "tiledb_array_schema", function(x, value) { libtiledb_array_schema_set_capacity(x@ptr, value) x @@ -676,7 +681,7 @@ setReplaceMethod( #' Retrieve schema capacity (for sparse fragments) #' #' Returns the \code{tiledb_array} schema tile capacity for sparse fragments. -#' @param object An \code{array_schema} object +#' @param object A TileDB Schema object #' @return The tile capacity value #' @export tiledb_array_schema_get_capacity <- function(object) { @@ -687,14 +692,16 @@ tiledb_array_schema_get_capacity <- function(object) { #' Sets the schema capacity (for sparse fragments) #' #' Sets the \code{tiledb_array} schema tile capacity for sparse fragments. -#' @param x An \code{array_schema} object +#' @param x A TileDB Schema object #' @param value An integer or numeric value for the new tile capacity -#' @return The modified \code{array_schema} object +#' +#' @return The modified `tiledb_array_schema` object. +#' #' @export tiledb_array_schema_set_capacity <- function(x, value) { stopifnot( `The first argument must be a tiledb_array_schema object` = is(x, "tiledb_array_schema"), - `The second argumebt must be a int or numeric value` = is.numeric(value) + `The second argument must be a int or numeric value` = is.numeric(value) ) libtiledb_array_schema_set_capacity(x@ptr, value) x @@ -713,7 +720,7 @@ setGeneric("schema_check", function(object) standardGeneric("schema_check")) #' @export setMethod( "schema_check", - signature = "tiledb_array_schema", + signature = "tiledb_array_schema", definition = function(object) { libtiledb_array_schema_check(object@ptr) } @@ -736,7 +743,7 @@ setMethod("check", signature = "tiledb_array_schema", function(object) { #' Check the schema for correctness #' #' Returns the \code{tiledb_array} schema for correctness -#' @param object An \code{array_schema} object +#' @param object A TileDB Schema object #' @return The boolean value \code{TRUE} is returned for a correct #' schema; for an incorrect schema an error condition is triggered. #' @export @@ -748,7 +755,7 @@ tiledb_array_schema_check <- function(object) { #' Check the version of the array schema #' #' Returns the (internal) version of the \code{tiledb_array} schema -#' @param object An \code{array_schema} object +#' @param object A TileDB Schema object #' @return An integer value describing the internal schema format version #' @export tiledb_array_schema_version <- function(object) { @@ -762,7 +769,7 @@ tiledb_array_schema_version <- function(object) { #' Check a schema for a given attribute name #' -#' @param schema A schema for a TileDB Array +#' @param schema A TileDB Schema object #' @param attr A character variable with an attribute name #' @return A boolean value indicating if the attribute exists in the schema #' @export @@ -1010,7 +1017,7 @@ describe <- function(arr) { #' Add an empty Enumeration to a Schema #' -#' @param schema An Array Schema +#' @param schema A TileDB Schema object #' @param attr An Attribute for which an empty Enumeration will be added #' @param enum_name A character value with the Enumeration name #' @param type_str A character value with the TileDB type, defaults to \sQuote{ASCII} @@ -1019,14 +1026,17 @@ describe <- function(arr) { #' @param ordered A logical value indicated standard \code{factor} (when \code{FALSE}, the default) #' or \code{ordered} (when \code{TRUE}) #' @param ctx Optional tiledb_ctx object +#' +#' @return The modified `tiledb_array_schema` object. +#' #' @export tiledb_array_schema_set_enumeration_empty <- function( - schema, - attr, + schema, + attr, enum_name, type_str = "ASCII", cell_val_num = NA_integer_, - ordered = FALSE, + ordered = FALSE, ctx = tiledb_get_context() ) { stopifnot( @@ -1048,13 +1058,16 @@ tiledb_array_schema_set_enumeration_empty <- function( #' Get the Current Domain of an Array Schema #' -#' Note that 'CurrendDomain' object may be empty. -#' @param schema An Array Schema +#' Note that `tiledb_current_domain` object may be empty. +#' +#' @param schema A TileDB Schema object #' @param ctx Optional tiledb_ctx object -#' @return A 'CurrendDomain' object +#' +#' @return An object of class `tiledb_current_domain`. +#' #' @export tiledb_array_schema_get_current_domain <- function( - schema, + schema, ctx = tiledb_get_context() ) { stopifnot( @@ -1067,14 +1080,16 @@ tiledb_array_schema_get_current_domain <- function( #' Set a Current Domain of an Array Schema #' -#' @param schema An Array Schema -#' @param cd An CurrendDomain object +#' @param schema A TileDB Schema object +#' @param cd A TileDB Current Domain object #' @param ctx Optional tiledb_ctx object +#' #' @return Nothing is returned from this function (but an error, should it occur is reported) +#' #' @export tiledb_array_schema_set_current_domain <- function( - schema, - cd, + schema, + cd, ctx = tiledb_get_context() ) { stopifnot( diff --git a/R/Dim.R b/R/Dim.R index a666469b97..7dc2511b93 100644 --- a/R/Dim.R +++ b/R/Dim.R @@ -46,7 +46,7 @@ tiledb_dim.from_ptr <- function(ptr) { #' @param filter_list An optional \code{tiledb_filter_list} object, default #' is no filter #' @param ctx tiledb_ctx object (optional) -#' @return `tiledb_dim` object +#' @return A `tiledb_dim` object #' @examples #' \dontshow{ #' ctx <- tiledb_ctx(limitTileDBCores()) @@ -56,11 +56,11 @@ tiledb_dim.from_ptr <- function(ptr) { #' @importFrom methods new #' @export tiledb_dim tiledb_dim <- function( - name, - domain, - tile, + name, + domain, + tile, type, - filter_list = tiledb_filter_list(), + filter_list = tiledb_filter_list(), ctx = tiledb_get_context() ) { stopifnot( @@ -153,7 +153,7 @@ tiledb_dim <- function( #' Prints a dimension object #' -#' @param object A dimension object +#' @param object A `tiledb_dim` object #' @export setMethod("show", signature(object = "tiledb_dim"), @@ -164,7 +164,7 @@ setMethod("show", #' Return the `tiledb_dim` name #' -#' @param object `tiledb_dim` object +#' @param object A `tiledb_dim` object #' @return string name, empty string if the dimension is anonymous #' @examples #' \dontshow{ @@ -186,7 +186,7 @@ setMethod( #' Return the `tiledb_dim` domain #' -#' @param object `tiledb_dim` object +#' @param object A `tiledb_dim` object #' @return a vector of (lb, ub) inclusive domain of the dimension #' @examples #' \dontshow{ @@ -209,8 +209,8 @@ setGeneric("tile", function(object) standardGeneric("tile")) #' Return the `tiledb_dim` tile extent #' -#' @param object `tiledb_dim` object -#' @return a scalar tile extent +#' @param object A `tiledb_dim` object +#' @return A scalar tile extent #' @examples #' \dontshow{ #' ctx <- tiledb_ctx(limitTileDBCores()) @@ -228,8 +228,8 @@ setMethod( #' Return the `tiledb_dim` datatype #' -#' @param object tiledb_dim object -#' @return tiledb datatype string +#' @param object A `tiledb_dim` object +#' @return A character string with tiledb's datatype. #' @examples #' \dontshow{ #' ctx <- tiledb_ctx(limitTileDBCores()) @@ -247,8 +247,8 @@ setMethod( #' Returns the number of dimensions for a tiledb domain object #' -#' @param object tiledb_ndim object -#' @return 1L +#' @param object A `tiledb_dim` object +#' @return An integer with the number of dimensions. #' @examples #' \dontshow{ #' ctx <- tiledb_ctx(limitTileDBCores()) @@ -268,7 +268,7 @@ setMethod( #' #' A TileDB dimension is anonymous if no name/label is defined #' -#' @param object `tiledb_dim` object +#' @param object A `tiledb_dim` object #' @return TRUE or FALSE #' @examples #' \dontshow{ @@ -289,8 +289,8 @@ is.anonymous.tiledb_dim <- function(object) { #' Retrieves the dimension of the tiledb_dim domain #' -#' @param x `tiledb_dim` object -#' @return a vector of the tile_dim domain type, of the dim domain dimension (extent) +#' @param x A `tiledb_dim` object +#' @return A vector of the tile_dim domain type, of the dim domain dimension (extent) #' @examples #' \dontshow{ #' ctx <- tiledb_ctx(limitTileDBCores()) @@ -313,8 +313,8 @@ dim.tiledb_dim <- function(x) { #' Returns the TileDB Filter List object associated with the given TileDB Dimension #' -#' @param object TileDB_Dimension -#' @return A TileDB_filter_list object +#' @param object A `tiledb_dim` object +#' @return A `tiledb_filter_list` object #' @export setMethod("filter_list", "tiledb_dim", function(object) { ptr <- libtiledb_dimension_get_filter_list(object@ptr) @@ -325,7 +325,7 @@ setMethod("filter_list", "tiledb_dim", function(object) { #' Sets the TileDB Filter List for the TileDB Dimension object #' -#' @param x TileDB Dimension +#' @param x A `tiledb_dim` object #' @param value TileDB Filter List #' @return The modified TileDB Dimension object #' @export @@ -344,7 +344,7 @@ setMethod("cell_val_num", signature(object = "tiledb_dim"), function(object) { #' Return the number of scalar values per dimension cell #' -#' @param object `tiledb_dim` object +#' @param object A `tiledb_dim` object #' @return integer number of cells #' @export tiledb_dim_get_cell_val_num <- function(object) { diff --git a/R/FragmentInfo.R b/R/FragmentInfo.R index 451f5b5986..8475317a7c 100644 --- a/R/FragmentInfo.R +++ b/R/FragmentInfo.R @@ -35,8 +35,8 @@ tiledb_fragment_info.from_ptr <- function(ptr) { #' Constructs a `tiledb_fragment_info` object #' -#' @param uri an character variable with the URI of the -#' array for which fragment info is request +#' @param uri A character variable with the URI of the +#' array for which fragment info is requested #' @param ctx tiledb_ctx object (optional) #' @return tiledb_fragment_info object #' @export tiledb_fragment_info @@ -101,7 +101,7 @@ tiledb_fragment_info_get_non_empty_domain_index <- function(object, fid, did, ty #' @param fid A fragment object index #' @param dim_name A character variable with the dimension name #' @param typestr An optional character variable describing the data type which will -#' be accessed from the schema if missinh +#' be accessed from the schema if missing #' @return A TileDB Domain object #' @export tiledb_fragment_info_get_non_empty_domain_name <- function(object, fid, dim_name, typestr) { diff --git a/R/NDRectangle.R b/R/NDRectangle.R index 66449c9d14..a01076bd8c 100644 --- a/R/NDRectangle.R +++ b/R/NDRectangle.R @@ -77,7 +77,7 @@ tiledb_ndrectangle <- function(dom, ctx = tiledb_get_context()) { tiledb_ndrectangle_set_range <- function(ndr, dimname, start, end) { stopifnot( "The first argument must be a TileDB NDRectangle object" = is(ndr, "tiledb_ndrectangle"), - "The second argument must a single character object" = is.character(dimname) && + "The second argument must be a single character object" = is.character(dimname) && length(dimname) == 1, "The third argument must be scalar" = length(start) == 1, "The fourth argument must be scalar" = length(end) == 1, @@ -108,7 +108,7 @@ tiledb_ndrectangle_set_range <- function(ndr, dimname, start, end) { tiledb_ndrectangle_get_range <- function(ndr, dimname) { stopifnot( "The first argument must be a TileDB NDRectangle object" = is(ndr, "tiledb_ndrectangle"), - "The second argument must a single character object" = is.character(dimname) && + "The second argument must be a single character object" = is.character(dimname) && length(dimname) == 1, "This function needs TileDB 2.26.0 or later" = tiledb_version(TRUE) >= "2.26.0" ) @@ -157,7 +157,7 @@ tiledb_ndrectangle_dim_num <- function(ndr) { tiledb_ndrectangle_datatype <- function(ndr, dimname) { stopifnot( "The first argument must be a TileDB NDRectangle object" = is(ndr, "tiledb_ndrectangle"), - "The second argument must a single character object" = is.character(dimname) && + "The second argument must be a single character object" = is.character(dimname) && length(dimname) == 1, "This function needs TileDB 2.26.0 or later" = tiledb_version(TRUE) >= "2.26.0" ) @@ -182,7 +182,7 @@ tiledb_ndrectangle_datatype <- function(ndr, dimname) { tiledb_ndrectangle_datatype_by_ind <- function(ndr, dim) { stopifnot( "The first argument must be a TileDB NDRectangle object" = is(ndr, "tiledb_ndrectangle"), - "The second argument must a single numeric object" = is.numeric(dim) && + "The second argument must be a single numeric object" = is.numeric(dim) && length(dim) == 1, "This function needs TileDB 2.26.0 or later" = tiledb_version(TRUE) >= "2.26.0" ) diff --git a/man/attrs-tiledb_array_schema-ANY-method.Rd b/man/attrs-tiledb_array_schema-ANY-method.Rd index b80dbfb037..31b5cc19f2 100644 --- a/man/attrs-tiledb_array_schema-ANY-method.Rd +++ b/man/attrs-tiledb_array_schema-ANY-method.Rd @@ -7,14 +7,14 @@ \S4method{attrs}{tiledb_array_schema,ANY}(object, idx, ...) } \arguments{ -\item{object}{tiledb_array_schema} +\item{object}{A TileDB Schema object} \item{idx}{index argument, currently unused.} \item{...}{Extra parameter for method signature, currently unused.} } \value{ -a list of tiledb_attr objects +A list of \code{tiledb_attr} objects } \description{ Returns a list of all \code{tiledb_attr} objects associated with the \code{tiledb_array_schema} diff --git a/man/attrs-tiledb_array_schema-character-method.Rd b/man/attrs-tiledb_array_schema-character-method.Rd index d70292735c..497ad40e04 100644 --- a/man/attrs-tiledb_array_schema-character-method.Rd +++ b/man/attrs-tiledb_array_schema-character-method.Rd @@ -7,14 +7,14 @@ \S4method{attrs}{tiledb_array_schema,character}(object, idx, ...) } \arguments{ -\item{object}{tiledb_array_schema} +\item{object}{A TileDB Schema object} \item{idx}{attribute name string} \item{...}{Extra parameter for method signature, currently unused.} } \value{ -a \code{tiledb_attr} object +A \code{tiledb_attr} object } \description{ Returns a \code{tiledb_attr} object associated with the \code{tiledb_array_schema} with a given name. diff --git a/man/attrs-tiledb_array_schema-numeric-method.Rd b/man/attrs-tiledb_array_schema-numeric-method.Rd index 6531e644fc..1370d21cad 100644 --- a/man/attrs-tiledb_array_schema-numeric-method.Rd +++ b/man/attrs-tiledb_array_schema-numeric-method.Rd @@ -7,14 +7,14 @@ \S4method{attrs}{tiledb_array_schema,numeric}(object, idx, ...) } \arguments{ -\item{object}{tiledb_array_schema} +\item{object}{A TileDB Schema object} \item{idx}{attribute index} \item{...}{Extra parameter for method signature, currently unused.} } \value{ -a \code{tiledb_attr} object +A \code{tiledb_attr} object } \description{ The attribute index is defined by the order the attributes were defined in the schema diff --git a/man/cell_order-tiledb_array_schema-method.Rd b/man/cell_order-tiledb_array_schema-method.Rd index 7dee50a644..4f8a20c6e6 100644 --- a/man/cell_order-tiledb_array_schema-method.Rd +++ b/man/cell_order-tiledb_array_schema-method.Rd @@ -7,7 +7,10 @@ \S4method{cell_order}{tiledb_array_schema}(object) } \arguments{ -\item{object}{tiledb object} +\item{object}{A TileDB Schema object} +} +\value{ +A character string with cell's layout, e.g., \code{"COL_MAJOR"}. } \description{ Returns the cell layout string associated with the \code{tiledb_array_schema} diff --git a/man/datatype-tiledb_dim-method.Rd b/man/datatype-tiledb_dim-method.Rd index 278e4408ee..f97ee055d4 100644 --- a/man/datatype-tiledb_dim-method.Rd +++ b/man/datatype-tiledb_dim-method.Rd @@ -7,10 +7,10 @@ \S4method{datatype}{tiledb_dim}(object) } \arguments{ -\item{object}{tiledb_dim object} +\item{object}{A \code{tiledb_dim} object} } \value{ -tiledb datatype string +A character string with tiledb's datatype. } \description{ Return the \code{tiledb_dim} datatype diff --git a/man/dim.tiledb_array_schema.Rd b/man/dim.tiledb_array_schema.Rd index f1e2153c5b..25d53e8728 100644 --- a/man/dim.tiledb_array_schema.Rd +++ b/man/dim.tiledb_array_schema.Rd @@ -7,7 +7,7 @@ \method{dim}{tiledb_array_schema}(x) } \arguments{ -\item{x}{tiledb_array_schema} +\item{x}{A TileDB Schema object} } \value{ a dimension vector diff --git a/man/dim.tiledb_dim.Rd b/man/dim.tiledb_dim.Rd index 25d263489f..816858c3bb 100644 --- a/man/dim.tiledb_dim.Rd +++ b/man/dim.tiledb_dim.Rd @@ -7,10 +7,10 @@ \method{dim}{tiledb_dim}(x) } \arguments{ -\item{x}{\code{tiledb_dim} object} +\item{x}{A \code{tiledb_dim} object} } \value{ -a vector of the tile_dim domain type, of the dim domain dimension (extent) +A vector of the tile_dim domain type, of the dim domain dimension (extent) } \description{ Retrieves the dimension of the tiledb_dim domain diff --git a/man/dimensions-tiledb_array_schema-method.Rd b/man/dimensions-tiledb_array_schema-method.Rd index 39a6cd0f67..da34b3d347 100644 --- a/man/dimensions-tiledb_array_schema-method.Rd +++ b/man/dimensions-tiledb_array_schema-method.Rd @@ -7,10 +7,10 @@ \S4method{dimensions}{tiledb_array_schema}(object) } \arguments{ -\item{object}{tiledb_array_schema} +\item{object}{A TileDB Schema object} } \value{ -a list of tiledb_dim objects +A list of \code{tiledb_dim} objects } \description{ Returns a list of \code{tiledb_dim} objects associated with the \code{tiledb_array_schema} diff --git a/man/domain-tiledb_array_schema-method.Rd b/man/domain-tiledb_array_schema-method.Rd index 3a235d6818..98ad15c7ac 100644 --- a/man/domain-tiledb_array_schema-method.Rd +++ b/man/domain-tiledb_array_schema-method.Rd @@ -7,7 +7,10 @@ \S4method{domain}{tiledb_array_schema}(object) } \arguments{ -\item{object}{tiledb_array_schema} +\item{object}{A TileDB Schema object} +} +\value{ +A \code{tiledb_domain} object } \description{ Returns the \code{tiledb_domain} object associated with a given \code{tiledb_array_schema} diff --git a/man/domain-tiledb_dim-method.Rd b/man/domain-tiledb_dim-method.Rd index 15cfaa3a56..61fa1ace6d 100644 --- a/man/domain-tiledb_dim-method.Rd +++ b/man/domain-tiledb_dim-method.Rd @@ -7,7 +7,7 @@ \S4method{domain}{tiledb_dim}(object) } \arguments{ -\item{object}{\code{tiledb_dim} object} +\item{object}{A \code{tiledb_dim} object} } \value{ a vector of (lb, ub) inclusive domain of the dimension diff --git a/man/filter_list-set-tiledb_dim-method.Rd b/man/filter_list-set-tiledb_dim-method.Rd index b2c0fa8741..d651e091e6 100644 --- a/man/filter_list-set-tiledb_dim-method.Rd +++ b/man/filter_list-set-tiledb_dim-method.Rd @@ -7,7 +7,7 @@ \S4method{filter_list}{tiledb_dim}(x) <- value } \arguments{ -\item{x}{TileDB Dimension} +\item{x}{A \code{tiledb_dim} object} \item{value}{TileDB Filter List} } diff --git a/man/filter_list-tiledb_array_schema-method.Rd b/man/filter_list-tiledb_array_schema-method.Rd index 8931a74931..2de1b6b658 100644 --- a/man/filter_list-tiledb_array_schema-method.Rd +++ b/man/filter_list-tiledb_array_schema-method.Rd @@ -7,10 +7,10 @@ \S4method{filter_list}{tiledb_array_schema}(object) } \arguments{ -\item{object}{tiledb_array_schema} +\item{object}{A TileDB Schema object} } \value{ -a list of tiledb_filter_list objects +A list of \code{tiledb_filter_list} objects } \description{ Returns the offsets and coordinate filter_lists associated with the \code{tiledb_array_schema} diff --git a/man/filter_list-tiledb_dim-method.Rd b/man/filter_list-tiledb_dim-method.Rd index 029fac2a8d..fc797013c6 100644 --- a/man/filter_list-tiledb_dim-method.Rd +++ b/man/filter_list-tiledb_dim-method.Rd @@ -7,10 +7,10 @@ \S4method{filter_list}{tiledb_dim}(object) } \arguments{ -\item{object}{TileDB_Dimension} +\item{object}{A \code{tiledb_dim} object} } \value{ -A TileDB_filter_list object +A \code{tiledb_filter_list} object } \description{ Returns the TileDB Filter List object associated with the given TileDB Dimension diff --git a/man/has_attribute.Rd b/man/has_attribute.Rd index 75f65040a4..b8c17734b9 100644 --- a/man/has_attribute.Rd +++ b/man/has_attribute.Rd @@ -7,7 +7,7 @@ has_attribute(schema, attr) } \arguments{ -\item{schema}{A schema for a TileDB Array} +\item{schema}{A TileDB Schema object} \item{attr}{A character variable with an attribute name} } diff --git a/man/is.anonymous.tiledb_dim.Rd b/man/is.anonymous.tiledb_dim.Rd index 1f619b2eb6..942f94d5eb 100644 --- a/man/is.anonymous.tiledb_dim.Rd +++ b/man/is.anonymous.tiledb_dim.Rd @@ -7,7 +7,7 @@ \method{is.anonymous}{tiledb_dim}(object) } \arguments{ -\item{object}{\code{tiledb_dim} object} +\item{object}{A \code{tiledb_dim} object} } \value{ TRUE or FALSE diff --git a/man/is.sparse-tiledb_array_schema-method.Rd b/man/is.sparse-tiledb_array_schema-method.Rd index ce7a999d1c..9df7c630ad 100644 --- a/man/is.sparse-tiledb_array_schema-method.Rd +++ b/man/is.sparse-tiledb_array_schema-method.Rd @@ -7,10 +7,10 @@ \S4method{is.sparse}{tiledb_array_schema}(object) } \arguments{ -\item{object}{tiledb_array_schema} +\item{object}{A TileDB Schema object} } \value{ -TRUE if tiledb_array_schema is sparse +\code{TRUE} if \code{tiledb_array_schema} object is sparse } \description{ Returns TRUE if the tiledb_array_schema is sparse, else FALSE diff --git a/man/name-tiledb_dim-method.Rd b/man/name-tiledb_dim-method.Rd index 05163bb11f..a364aea706 100644 --- a/man/name-tiledb_dim-method.Rd +++ b/man/name-tiledb_dim-method.Rd @@ -7,7 +7,7 @@ \S4method{name}{tiledb_dim}(object) } \arguments{ -\item{object}{\code{tiledb_dim} object} +\item{object}{A \code{tiledb_dim} object} } \value{ string name, empty string if the dimension is anonymous diff --git a/man/raw_dump-tiledb_array_schema-method.Rd b/man/raw_dump-tiledb_array_schema-method.Rd index 4033322a63..6fb1938c51 100644 --- a/man/raw_dump-tiledb_array_schema-method.Rd +++ b/man/raw_dump-tiledb_array_schema-method.Rd @@ -7,7 +7,7 @@ \S4method{raw_dump}{tiledb_array_schema}(object) } \arguments{ -\item{object}{An array_schema object} +\item{object}{A TileDB Schema object} } \description{ This method used the display method provided by the underlying diff --git a/man/show-tiledb_array_schema-method.Rd b/man/show-tiledb_array_schema-method.Rd index 470a26de11..54b7366647 100644 --- a/man/show-tiledb_array_schema-method.Rd +++ b/man/show-tiledb_array_schema-method.Rd @@ -7,7 +7,7 @@ \S4method{show}{tiledb_array_schema}(object) } \arguments{ -\item{object}{An array_schema object} +\item{object}{A TileDB Schema object} } \description{ Prints an array schema object diff --git a/man/show-tiledb_dim-method.Rd b/man/show-tiledb_dim-method.Rd index d208cf0d69..0efa961623 100644 --- a/man/show-tiledb_dim-method.Rd +++ b/man/show-tiledb_dim-method.Rd @@ -7,7 +7,7 @@ \S4method{show}{tiledb_dim}(object) } \arguments{ -\item{object}{A dimension object} +\item{object}{A \code{tiledb_dim} object} } \description{ Prints a dimension object diff --git a/man/tile-tiledb_dim-method.Rd b/man/tile-tiledb_dim-method.Rd index 3789607e96..33aecd9afb 100644 --- a/man/tile-tiledb_dim-method.Rd +++ b/man/tile-tiledb_dim-method.Rd @@ -7,10 +7,10 @@ \S4method{tile}{tiledb_dim}(object) } \arguments{ -\item{object}{\code{tiledb_dim} object} +\item{object}{A \code{tiledb_dim} object} } \value{ -a scalar tile extent +A scalar tile extent } \description{ Return the \code{tiledb_dim} tile extent diff --git a/man/tile_order-tiledb_array_schema-method.Rd b/man/tile_order-tiledb_array_schema-method.Rd index 06f424125b..b485378275 100644 --- a/man/tile_order-tiledb_array_schema-method.Rd +++ b/man/tile_order-tiledb_array_schema-method.Rd @@ -7,7 +7,10 @@ \S4method{tile_order}{tiledb_array_schema}(object) } \arguments{ -\item{object}{tiledb object} +\item{object}{A TileDB Schema object} +} +\value{ +A character string with tile's layout, e.g., \code{"COL_MAJOR"}. } \description{ Returns the tile layout string associated with the \code{tiledb_array_schema} diff --git a/man/tiledb_array_create.Rd b/man/tiledb_array_create.Rd index eb795e0fa3..0e0f4f56ed 100644 --- a/man/tiledb_array_create.Rd +++ b/man/tiledb_array_create.Rd @@ -12,7 +12,7 @@ tiledb_array_create(uri, schema, encryption_key) \item{schema}{tiledb_array_schema object} \item{encryption_key}{optional A character value with an AES-256 encryption key -in case the array should be encryption.} +in case the array should be encrypted.} } \description{ Creates a new TileDB array given an input schema. diff --git a/man/tiledb_array_schema.Rd b/man/tiledb_array_schema.Rd index 72a05baa85..8ee0248150 100644 --- a/man/tiledb_array_schema.Rd +++ b/man/tiledb_array_schema.Rd @@ -44,6 +44,9 @@ tiledb_array_schema( \item{ctx}{tiledb_ctx object (optional)} } +\value{ +An object of class \code{tiledb_array_schema}. +} \description{ Constructs a \code{tiledb_array_schema} object } diff --git a/man/tiledb_array_schema_check.Rd b/man/tiledb_array_schema_check.Rd index 2407abce9c..b4ea41a4c6 100644 --- a/man/tiledb_array_schema_check.Rd +++ b/man/tiledb_array_schema_check.Rd @@ -19,7 +19,7 @@ check(object) tiledb_array_schema_check(object) } \arguments{ -\item{object}{An \code{array_schema} object} +\item{object}{A TileDB Schema object} } \value{ The boolean value \code{TRUE} is returned for a correct diff --git a/man/tiledb_array_schema_get_allows_dups.Rd b/man/tiledb_array_schema_get_allows_dups.Rd index f2b3fadfce..6741b018a0 100644 --- a/man/tiledb_array_schema_get_allows_dups.Rd +++ b/man/tiledb_array_schema_get_allows_dups.Rd @@ -14,10 +14,10 @@ allows_dups(x) tiledb_array_schema_get_allows_dups(x) } \arguments{ -\item{x}{tiledb_array_schema} +\item{x}{A TileDB Schema object} } \value{ -the logical value +A logical value. } \description{ Returns logical value whether the array schema allows duplicate values or not. diff --git a/man/tiledb_array_schema_get_capacity.Rd b/man/tiledb_array_schema_get_capacity.Rd index a0c42ef565..3de1cda694 100644 --- a/man/tiledb_array_schema_get_capacity.Rd +++ b/man/tiledb_array_schema_get_capacity.Rd @@ -13,7 +13,7 @@ capacity(object) tiledb_array_schema_get_capacity(object) } \arguments{ -\item{object}{An \code{array_schema} object} +\item{object}{A TileDB Schema object} } \value{ The tile capacity value diff --git a/man/tiledb_array_schema_get_current_domain.Rd b/man/tiledb_array_schema_get_current_domain.Rd index b7581a02f9..de56f5654e 100644 --- a/man/tiledb_array_schema_get_current_domain.Rd +++ b/man/tiledb_array_schema_get_current_domain.Rd @@ -7,13 +7,13 @@ tiledb_array_schema_get_current_domain(schema, ctx = tiledb_get_context()) } \arguments{ -\item{schema}{An Array Schema} +\item{schema}{A TileDB Schema object} \item{ctx}{Optional tiledb_ctx object} } \value{ -A 'CurrendDomain' object +An object of class \code{tiledb_current_domain}. } \description{ -Note that 'CurrendDomain' object may be empty. +Note that \code{tiledb_current_domain} object may be empty. } diff --git a/man/tiledb_array_schema_set_allows_dups.Rd b/man/tiledb_array_schema_set_allows_dups.Rd index 45f80433dd..d9ed9ecee7 100644 --- a/man/tiledb_array_schema_set_allows_dups.Rd +++ b/man/tiledb_array_schema_set_allows_dups.Rd @@ -14,12 +14,12 @@ allows_dups(x) <- value tiledb_array_schema_set_allows_dups(x, value) } \arguments{ -\item{x}{tiledb_array_schema} +\item{x}{A TileDB Schema object} \item{value}{logical value} } \value{ -the tiledb_array_schema object +An object of class \code{tiledb_array_schema}. } \description{ Sets toggle whether the array schema allows duplicate values or not. diff --git a/man/tiledb_array_schema_set_capacity.Rd b/man/tiledb_array_schema_set_capacity.Rd index 02c790325b..8c3e5f149e 100644 --- a/man/tiledb_array_schema_set_capacity.Rd +++ b/man/tiledb_array_schema_set_capacity.Rd @@ -13,12 +13,12 @@ capacity(x) <- value tiledb_array_schema_set_capacity(x, value) } \arguments{ -\item{x}{An \code{array_schema} object} +\item{x}{A TileDB Schema object} \item{value}{An integer or numeric value for the new tile capacity} } \value{ -The modified \code{array_schema} object +The modified \code{tiledb_array_schema} object. } \description{ Sets the \code{tiledb_array} schema tile capacity for sparse fragments. diff --git a/man/tiledb_array_schema_set_coords_filter_list.Rd b/man/tiledb_array_schema_set_coords_filter_list.Rd index 633c31b2ba..03aac8197b 100644 --- a/man/tiledb_array_schema_set_coords_filter_list.Rd +++ b/man/tiledb_array_schema_set_coords_filter_list.Rd @@ -7,12 +7,12 @@ tiledb_array_schema_set_coords_filter_list(sch, fl) } \arguments{ -\item{sch}{A TileDB Array Schema object} +\item{sch}{A TileDB Schema object} \item{fl}{A TileDB Filter List object} } \value{ -The modified Array Schema object +The modified \code{tiledb_array_schema} object. } \description{ Set a Filter List for Coordinate of a TileDB Schema diff --git a/man/tiledb_array_schema_set_current_domain.Rd b/man/tiledb_array_schema_set_current_domain.Rd index 88b02ce7d7..f8ff23ebcd 100644 --- a/man/tiledb_array_schema_set_current_domain.Rd +++ b/man/tiledb_array_schema_set_current_domain.Rd @@ -7,9 +7,9 @@ tiledb_array_schema_set_current_domain(schema, cd, ctx = tiledb_get_context()) } \arguments{ -\item{schema}{An Array Schema} +\item{schema}{A TileDB Schema object} -\item{cd}{An CurrendDomain object} +\item{cd}{A TileDB Current Domain object} \item{ctx}{Optional tiledb_ctx object} } diff --git a/man/tiledb_array_schema_set_enumeration_empty.Rd b/man/tiledb_array_schema_set_enumeration_empty.Rd index 738b308d90..451200746c 100644 --- a/man/tiledb_array_schema_set_enumeration_empty.Rd +++ b/man/tiledb_array_schema_set_enumeration_empty.Rd @@ -15,7 +15,7 @@ tiledb_array_schema_set_enumeration_empty( ) } \arguments{ -\item{schema}{An Array Schema} +\item{schema}{A TileDB Schema object} \item{attr}{An Attribute for which an empty Enumeration will be added} @@ -31,6 +31,9 @@ or \code{ordered} (when \code{TRUE})} \item{ctx}{Optional tiledb_ctx object} } +\value{ +The modified \code{tiledb_array_schema} object. +} \description{ Add an empty Enumeration to a Schema } diff --git a/man/tiledb_array_schema_set_offsets_filter_list.Rd b/man/tiledb_array_schema_set_offsets_filter_list.Rd index 854e46330b..0c385041c0 100644 --- a/man/tiledb_array_schema_set_offsets_filter_list.Rd +++ b/man/tiledb_array_schema_set_offsets_filter_list.Rd @@ -7,12 +7,12 @@ tiledb_array_schema_set_offsets_filter_list(sch, fl) } \arguments{ -\item{sch}{A TileDB Array Schema object} +\item{sch}{A TileDB Schema object} \item{fl}{A TileDB Filter List object} } \value{ -The modified Array Schema object +The modified \code{tiledb_array_schema} object. } \description{ Set a Filter List for Variable-Sized Offsets of a TileDB Schema diff --git a/man/tiledb_array_schema_set_validity_filter_list.Rd b/man/tiledb_array_schema_set_validity_filter_list.Rd index 01b647336b..fdb5afbba6 100644 --- a/man/tiledb_array_schema_set_validity_filter_list.Rd +++ b/man/tiledb_array_schema_set_validity_filter_list.Rd @@ -7,12 +7,12 @@ tiledb_array_schema_set_validity_filter_list(sch, fl) } \arguments{ -\item{sch}{A TileDB Array Schema object} +\item{sch}{A TileDB Schema object} \item{fl}{A TileDB Filter List object} } \value{ -The modified Array Schema object +The modified \code{tiledb_array_schema} object. } \description{ Set a Filter List for Validity of a TileDB Schema diff --git a/man/tiledb_array_schema_version.Rd b/man/tiledb_array_schema_version.Rd index dc3fb85af3..01cc0568ab 100644 --- a/man/tiledb_array_schema_version.Rd +++ b/man/tiledb_array_schema_version.Rd @@ -7,7 +7,7 @@ tiledb_array_schema_version(object) } \arguments{ -\item{object}{An \code{array_schema} object} +\item{object}{A TileDB Schema object} } \value{ An integer value describing the internal schema format version diff --git a/man/tiledb_dim.Rd b/man/tiledb_dim.Rd index f8908c1904..0a0120870b 100644 --- a/man/tiledb_dim.Rd +++ b/man/tiledb_dim.Rd @@ -31,7 +31,7 @@ is no filter} \item{ctx}{tiledb_ctx object (optional)} } \value{ -\code{tiledb_dim} object +A \code{tiledb_dim} object } \description{ Constructs a \code{tiledb_dim} object diff --git a/man/tiledb_dim_get_cell_val_num.Rd b/man/tiledb_dim_get_cell_val_num.Rd index f226e8a49c..b7159facea 100644 --- a/man/tiledb_dim_get_cell_val_num.Rd +++ b/man/tiledb_dim_get_cell_val_num.Rd @@ -10,7 +10,7 @@ tiledb_dim_get_cell_val_num(object) } \arguments{ -\item{object}{\code{tiledb_dim} object} +\item{object}{A \code{tiledb_dim} object} } \value{ integer number of cells diff --git a/man/tiledb_fragment_info.Rd b/man/tiledb_fragment_info.Rd index 8e15b8149d..cd73d079d9 100644 --- a/man/tiledb_fragment_info.Rd +++ b/man/tiledb_fragment_info.Rd @@ -7,8 +7,8 @@ tiledb_fragment_info(uri, ctx = tiledb_get_context()) } \arguments{ -\item{uri}{an character variable with the URI of the -array for which fragment info is request} +\item{uri}{A character variable with the URI of the +array for which fragment info is requested} \item{ctx}{tiledb_ctx object (optional)} } diff --git a/man/tiledb_fragment_info_get_non_empty_domain_name.Rd b/man/tiledb_fragment_info_get_non_empty_domain_name.Rd index 1a9ad79fa0..c49c1eb80f 100644 --- a/man/tiledb_fragment_info_get_non_empty_domain_name.Rd +++ b/man/tiledb_fragment_info_get_non_empty_domain_name.Rd @@ -14,7 +14,7 @@ tiledb_fragment_info_get_non_empty_domain_name(object, fid, dim_name, typestr) \item{dim_name}{A character variable with the dimension name} \item{typestr}{An optional character variable describing the data type which will -be accessed from the schema if missinh} +be accessed from the schema if missing} } \value{ A TileDB Domain object diff --git a/man/tiledb_ndim-tiledb_array_schema-method.Rd b/man/tiledb_ndim-tiledb_array_schema-method.Rd index f264a982af..cfc4314552 100644 --- a/man/tiledb_ndim-tiledb_array_schema-method.Rd +++ b/man/tiledb_ndim-tiledb_array_schema-method.Rd @@ -7,7 +7,7 @@ \S4method{tiledb_ndim}{tiledb_array_schema}(object) } \arguments{ -\item{object}{tiledb_array_schema} +\item{object}{A TileDB Schema object} } \value{ integer number of dimensions diff --git a/man/tiledb_ndim-tiledb_dim-method.Rd b/man/tiledb_ndim-tiledb_dim-method.Rd index a1827b7cc9..0d287ba69b 100644 --- a/man/tiledb_ndim-tiledb_dim-method.Rd +++ b/man/tiledb_ndim-tiledb_dim-method.Rd @@ -7,10 +7,10 @@ \S4method{tiledb_ndim}{tiledb_dim}(object) } \arguments{ -\item{object}{tiledb_ndim object} +\item{object}{A \code{tiledb_dim} object} } \value{ -1L +An integer with the number of dimensions. } \description{ Returns the number of dimensions for a tiledb domain object