ceph/src/arrow/r/R/array-data.R

   1 # Licensed to the Apache Software Foundation (ASF) under one
   2 # or more contributor license agreements.  See the NOTICE file
   3 # distributed with this work for additional information
   4 # regarding copyright ownership.  The ASF licenses this file
   5 # to you under the Apache License, Version 2.0 (the
   6 # "License"); you may not use this file except in compliance
   7 # with the License.  You may obtain a copy of the License at
   8 #
   9 #   http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 # Unless required by applicable law or agreed to in writing,
  12 # software distributed under the License is distributed on an
  13 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  14 # KIND, either express or implied.  See the License for the
  15 # specific language governing permissions and limitations
  16 # under the License.
  17
  18 #' @title ArrayData class
  19 #' @usage NULL
  20 #' @format NULL
  21 #' @docType class
  22 #' @description The `ArrayData` class allows you to get and inspect the data
  23 #' inside an `arrow::Array`.
  24 #'
  25 #' @section Usage:
  26 #'
  27 #' ```
  28 #' data <- Array$create(x)$data()
  29 #'
  30 #' data$type
  31 #' data$length
  32 #' data$null_count
  33 #' data$offset
  34 #' data$buffers
  35 #' ```
  36 #'
  37 #' @section Methods:
  38 #'
  39 #' ...
  40 #'
  41 #' @rdname ArrayData
  42 #' @name ArrayData
  43 #' @include type.R
  44 ArrayData <- R6Class("ArrayData",
  45   inherit = ArrowObject,
  46   active = list(
  47     type = function() ArrayData__get_type(self),
  48     length = function() ArrayData__get_length(self),
  49     null_count = function() ArrayData__get_null_count(self),
  50     offset = function() ArrayData__get_offset(self),
  51     buffers = function() ArrayData__buffers(self)
  52   )
  53 )