TileDB-R/man/tiledb_array_schema.Rd at 5fe50648c784b75601ad9a6c706442724b8859f2 · TileDB-Inc/TileDB-R · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ArraySchema.R
\name{tiledb_array_schema}
\alias{tiledb_array_schema}
\title{Constructs a \code{tiledb_array_schema} object}
\usage{
tiledb_array_schema(
  domain,
  attrs,
  cell_order = "COL_MAJOR",
  tile_order = "COL_MAJOR",
  sparse = FALSE,
  coords_filter_list = NULL,
  offsets_filter_list = NULL,
  validity_filter_list = NULL,
  capacity = 10000L,
  allows_dups = FALSE,
  enumerations = NULL,
  ctx = tiledb_get_context()
)
}
\arguments{
\item{domain}{tiledb_domain object}

\item{attrs}{a list of one or more tiledb_attr objects}

\item{cell_order}{(default "COL_MAJOR")}

\item{tile_order}{(default "COL_MAJOR")}

\item{sparse}{(default FALSE)}

\item{coords_filter_list}{(optional)}

\item{offsets_filter_list}{(optional)}

\item{validity_filter_list}{(optional)}

\item{capacity}{(optional)}

\item{allows_dups}{(optional, requires \sQuote{sparse} to be TRUE)}

\item{enumerations}{(optional) named list of enumerations}

\item{ctx}{tiledb_ctx object (optional)}
}
\value{
An object of class \code{tiledb_array_schema}.
}
\description{
Constructs a \code{tiledb_array_schema} object
}
\examples{
\dontshow{
ctx <- tiledb_ctx(limitTileDBCores())
}
schema <- tiledb_array_schema(
  domain = tiledb_domain(
    dims = c(
      tiledb_dim("rows", c(1L, 4L), 4L, "INT32"),
      tiledb_dim("cols", c(1L, 4L), 4L, "INT32")
    )
  ),
  attrs = c(tiledb_attr("a", type = "INT32")),
  cell_order = "COL_MAJOR",
  tile_order = "COL_MAJOR",
  sparse = FALSE
)
schema

}