apache · nealrichardson · Aug 26, 2019 · Aug 26, 2019 · Aug 26, 2019 · Aug 26, 2019
diff --git a/r/DESCRIPTION b/r/DESCRIPTION
@@ -47,7 +47,8 @@ Suggests:
     vctrs
 Collate:
     'enums.R'
-    'R6.R'
+    'arrow-package.R'
+    'type.R'
     'ArrayData.R'
     'ChunkedArray.R'
     'Column.R'
@@ -60,7 +61,6 @@ Collate:
     'Struct.R'
     'Table.R'
     'array.R'
-    'arrow-package.R'
     'arrowExports.R'
     'buffer.R'
     'io.R'

diff --git a/r/NAMESPACE b/r/NAMESPACE
@@ -122,6 +122,7 @@ export(TimeUnit)
 export(Type)
 export(array)
 export(arrow_available)
+export(bool)
 export(boolean)
 export(buffer)
 export(cast_options)
@@ -140,9 +141,11 @@ export(dictionary)
 export(ends_with)
 export(everything)
 export(field)
+export(float)
 export(float16)
 export(float32)
 export(float64)
+export(halffloat)
 export(install_arrow)
 export(int16)
 export(int32)
@@ -175,6 +178,7 @@ export(read_tsv_arrow)
 export(record_batch)
 export(schema)
 export(starts_with)
+export(string)
 export(struct)
 export(table)
 export(time32)

diff --git a/r/R/ArrayData.R b/r/R/ArrayData.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include type.R
 
 #' @title class arrow::ArrayData
 #'

diff --git a/r/R/ChunkedArray.R b/r/R/ChunkedArray.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 
 #' @title class arrow::ChunkedArray
 #'

diff --git a/r/R/Column.R b/r/R/Column.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include type.R
 
 #' @title class arrow::Column
 #'

diff --git a/r/R/Field.R b/r/R/Field.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 
 #' @title class arrow::Field
 #'
@@ -72,7 +72,14 @@
 #' @export
 field <- function(name, type, metadata) {
   assert_that(inherits(name, "character"), length(name) == 1L)
-  assert_that(inherits(type, "arrow::DataType"))
+  if (!inherits(type, "arrow::DataType")) {
+    if (identical(type, double())) {
+      # Magic so that we don't have to mask this base function
+      type <- float64()
+    } else {
+      stop(name, " must be arrow::DataType, not ", class(type), call. = FALSE)
+    }
+  }
   assert_that(missing(metadata), msg = "metadata= is currently ignored")
   shared_ptr(`arrow::Field`, Field__initialize(name, type, TRUE))
 }

diff --git a/r/R/List.R b/r/R/List.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include type.R
 
 `arrow::ListType` <- R6Class("arrow::ListType",
   inherit = `arrow::NestedType`,
@@ -25,6 +25,6 @@
   )
 )
 
-#' @rdname DataType
+#' @rdname data-type
 #' @export
 list_of <- function(type) shared_ptr(`arrow::ListType`, list__(type))
diff --git a/r/R/RecordBatch.R b/r/R/RecordBatch.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 
 #' @title class arrow::RecordBatch
 #'

diff --git a/r/R/RecordBatchReader.R b/r/R/RecordBatchReader.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 
 #' @title class arrow::RecordBatchReader
 #'

diff --git a/r/R/RecordBatchWriter.R b/r/R/RecordBatchWriter.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 
 #' @title class arrow::ipc::RecordBatchWriter
 #'

diff --git a/r/R/Schema.R b/r/R/Schema.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 
 #' @title class arrow::Schema
 #'
@@ -60,13 +60,19 @@
   lhs$Equals(rhs)
 }
 
-#' Schema factory
+#' Create a schema
 #'
-#' @param ... named list of data types
+#' This function lets you define a schema for a table. This is useful when you
+#' want to convert an R `data.frame` to Arrow but don't want to rely on the
+#' default mapping of R types to Arrow types, such as when you want to choose a
+#' specific numeric precision.
 #'
-#' @return a [schema][arrow__Schema]
+#' @param ... named list of [data types][data-type]
+#'
+#' @return A [schema][arrow__Schema] object.
 #'
 #' @export
+# TODO (npr): add examples once ARROW-5505 merges
 schema <- function(...){
   shared_ptr(`arrow::Schema`, schema_(.fields(list2(...))))
 }

diff --git a/r/R/Struct.R b/r/R/Struct.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include type.R
 
 `arrow::StructType` <- R6Class("arrow::StructType",
   inherit = `arrow::NestedType`,
@@ -25,7 +25,7 @@
   )
 )
 
-#' @rdname DataType
+#' @rdname data-type
 #' @export
 struct <- function(...){
   xp <- struct_(.fields(list(...)))

diff --git a/r/R/Table.R b/r/R/Table.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 #'
 #' @title class arrow::Table
 #'

diff --git a/r/R/array.R b/r/R/array.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 
 #' @title class arrow::Array
 #'

diff --git a/r/R/arrow-package.R b/r/R/arrow-package.R
@@ -42,3 +42,31 @@ arrow_available <- function() {
 option_use_threads <- function() {
   !is_false(getOption("arrow.use_threads"))
 }
+
+#' @include enums.R
+`arrow::Object` <- R6Class("arrow::Object",
+  public = list(
+    initialize = function(xp) self$set_pointer(xp),
+
+    pointer = function() self$`.:xp:.`,
+    `.:xp:.` = NULL,
+    set_pointer = function(xp){
+      self$`.:xp:.` <- xp
+    },
+    print = function(...){
+      cat(class(self)[[1]], "\n")
+      if (!is.null(self$ToString)){
+        cat(self$ToString(), "\n")
+      }
+      invisible(self)
+    }
+  )
+)
+
+shared_ptr <- function(class, xp) {
+  if (!shared_ptr_is_null(xp)) class$new(xp)
+}
+
+unique_ptr <- function(class, xp) {
+  if (!unique_ptr_is_null(xp)) class$new(xp)
+}
diff --git a/r/R/buffer.R b/r/R/buffer.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 #' @include enums.R
 
 #' @title class arrow::Buffer

diff --git a/r/R/compression.R b/r/R/compression.R
@@ -16,7 +16,7 @@
 # under the License.
 
 #' @include enums.R
-#' @include R6.R
+#' @include arrow-package.R
 #' @include io.R
 
 `arrow::util::Codec` <- R6Class("arrow::util::Codec", inherit = `arrow::Object`)

diff --git a/r/R/csv.R b/r/R/csv.R
@@ -189,7 +189,7 @@ read_tsv_arrow <- function(file,
   eval.parent(mc)
 }
 
-#' @include R6.R
+#' @include arrow-package.R
 
 `arrow::csv::TableReader` <- R6Class("arrow::csv::TableReader", inherit = `arrow::Object`,
   public = list(

diff --git a/r/R/dictionary.R b/r/R/dictionary.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include type.R
 
 #' @title class arrow::DictionaryType
 #'
@@ -40,14 +40,14 @@
   )
 )
 
-#' dictionary type factory
+#' Create a dictionary type
 #'
 #' @param index_type index type, e.g. [int32()]
 #' @param value_type value type, probably [utf8()]
 #' @param ordered Is this an ordered dictionary ?
 #'
-#' @return a [arrow::DictionaryType][arrow__DictionaryType]
-#'
+#' @return An [arrow::DictionaryType][arrow__DictionaryType]
+#' @seealso [Other Arrow data types][data-type]
 #' @export
 dictionary <- function(index_type, value_type, ordered = FALSE) {
   assert_that(

diff --git a/r/R/enums.R b/r/R/enums.R
@@ -27,17 +27,19 @@ enum <- function(class, ..., .list = list(...)){
   )
 }
 
-#' @rdname DataType
+#' Arrow enums
+#' @name enums
 #' @export
+#' @keywords internal
 TimeUnit <- enum("arrow::TimeUnit::type",
   SECOND = 0L, MILLI = 1L, MICRO = 2L, NANO = 3L
 )
 
-#' @rdname DataType
+#' @rdname enums
 #' @export
 DateUnit <- enum("arrow::DateUnit", DAY = 0L, MILLI = 1L)
 
-#' @rdname DataType
+#' @rdname enums
 #' @export
 Type <- enum("arrow::Type::type",
   "NA" = 0L, BOOL = 1L, UINT8 = 2L, INT8 = 3L, UINT16 = 4L, INT16 = 5L,
@@ -48,7 +50,7 @@ Type <- enum("arrow::Type::type",
   UNION = 25L, DICTIONARY = 26L, MAP = 27L
 )
 
-#' @rdname DataType
+#' @rdname enums
 #' @export
 StatusCode <- enum("arrow::StatusCode",
   OK = 0L, OutOfMemory = 1L, KeyError = 2L, TypeError = 3L,
@@ -59,19 +61,19 @@ StatusCode <- enum("arrow::StatusCode",
   PlasmaStoreFull = 22L, PlasmaObjectAlreadySealed = 23L
 )
 
-#' @rdname DataType
+#' @rdname enums
 #' @export
 FileMode <- enum("arrow::io::FileMode",
   READ = 0L, WRITE = 1L, READWRITE = 2L
 )
 
-#' @rdname DataType
+#' @rdname enums
 #' @export
 MessageType <- enum("arrow::ipc::Message::Type",
   NONE = 0L, SCHEMA = 1L, DICTIONARY_BATCH = 2L, RECORD_BATCH = 3L, TENSOR = 4L
 )
 
-#' @rdname DataType
+#' @rdname enums
 #' @export
 CompressionType <- enum("arrow::Compression::type",
   UNCOMPRESSED = 0L, SNAPPY = 1L, GZIP = 2L, BROTLI = 3L, ZSTD = 4L, LZ4 = 5L, LZO = 6L, BZ2 = 7L

diff --git a/r/R/feather.R b/r/R/feather.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 
 `arrow::ipc::feather::TableWriter` <- R6Class("arrow::ipc::feather::TableWriter", inherit = `arrow::Object`,
   public = list(

diff --git a/r/R/io.R b/r/R/io.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 #' @include enums.R
 #' @include buffer.R
 

diff --git a/r/R/json.R b/r/R/json.R
@@ -15,9 +15,9 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 
-#' @include R6.R
+#' @include arrow-package.R
 #'
 #' @title class arrow::json::TableReader
 #'

diff --git a/r/R/memory_pool.R b/r/R/memory_pool.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 #'
 #' @title class arrow::MemoryPool
 #'

diff --git a/r/R/message.R b/r/R/message.R
@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @include R6.R
+#' @include arrow-package.R
 
 #' @title class arrow::ipc::Message
 #'