ARROW-5505: [R] Normalize file and class names, stop masking base R functions, add vignette, improve documentation

dev/release/rat_exclude_files.txt

@@ -213,6 +213,7 @@ r/README.md
 r/README.Rmd
 r/man/*.Rd
 r/cran-comments.md
+r/vignettes/*.Rmd
 .gitattributes
 ruby/red-arrow/.yardopts
 rust/arrow/test/data/*.csv

r/DESCRIPTION

@@ -36,10 +36,12 @@ Imports:
     utils
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 6.1.1
+VignetteBuilder: knitr
 Suggests:
     covr,
     fs,
     hms,
+    knitr,
     lubridate,
     rmarkdown,
     testthat,
@@ -49,33 +51,33 @@ Collate:
     'enums.R'
     'arrow-package.R'
     'type.R'
-    'ArrayData.R'
-    'ChunkedArray.R'
-    'Column.R'
-    'Field.R'
-    'List.R'
-    'RecordBatch.R'
-    'RecordBatchReader.R'
-    'RecordBatchWriter.R'
-    'Schema.R'
-    'Struct.R'
-    'Table.R'
+    'array-data.R'
     'array.R'
     'arrowExports.R'
     'buffer.R'
+    'chunked-array.R'
     'io.R'
     'compression.R'
     'compute.R'
     'csv.R'
     'dictionary.R'
     'feather.R'
+    'field.R'
     'install-arrow.R'
     'json.R'
-    'memory_pool.R'
+    'list.R'
+    'memory-pool.R'
     'message.R'
     'parquet.R'
-    'read_record_batch.R'
-    'read_table.R'
+    'read-record-batch.R'
+    'read-table.R'
+    'record-batch-reader.R'
+    'record-batch-writer.R'
+    'record-batch.R'
     'reexports-bit64.R'
     'reexports-tidyselect.R'
-    'write_arrow.R'
+    'schema.R'
+    'struct.R'
+    'table.R'
+    'util.R'
+    'write-arrow.R'

r/NAMESPACE

@@ -1,114 +1,74 @@
 # Generated by roxygen2: do not edit by hand
 
-S3method("!=","arrow::Object")
-S3method("==","arrow::Array")
-S3method("==","arrow::DataType")
-S3method("==","arrow::Field")
-S3method("==","arrow::RecordBatch")
-S3method("==","arrow::Schema")
-S3method("==","arrow::ipc::Message")
-S3method(BufferReader,"arrow::Buffer")
-S3method(BufferReader,default)
-S3method(CompressedInputStream,"arrow::io::InputStream")
-S3method(CompressedInputStream,character)
-S3method(CompressedOutputStream,"arrow::io::OutputStream")
-S3method(CompressedOutputStream,character)
-S3method(FeatherTableReader,"arrow::io::RandomAccessFile")
-S3method(FeatherTableReader,"arrow::ipc::feather::TableReader")
-S3method(FeatherTableReader,character)
-S3method(FeatherTableReader,raw)
-S3method(FeatherTableWriter,"arrow::io::OutputStream")
-S3method(FixedSizeBufferWriter,"arrow::Buffer")
-S3method(FixedSizeBufferWriter,default)
-S3method(MessageReader,"arrow::io::InputStream")
-S3method(MessageReader,default)
-S3method(RecordBatchFileReader,"arrow::Buffer")
-S3method(RecordBatchFileReader,"arrow::io::RandomAccessFile")
-S3method(RecordBatchFileReader,character)
-S3method(RecordBatchFileReader,raw)
-S3method(RecordBatchFileWriter,"arrow::io::OutputStream")
-S3method(RecordBatchFileWriter,character)
-S3method(RecordBatchStreamReader,"arrow::Buffer")
-S3method(RecordBatchStreamReader,"arrow::io::InputStream")
-S3method(RecordBatchStreamReader,raw)
-S3method(RecordBatchStreamWriter,"arrow::io::OutputStream")
-S3method(RecordBatchStreamWriter,character)
-S3method(as.data.frame,"arrow::RecordBatch")
-S3method(as.data.frame,"arrow::Table")
-S3method(as.raw,"arrow::Buffer")
-S3method(buffer,"arrow::Buffer")
-S3method(buffer,complex)
-S3method(buffer,default)
-S3method(buffer,integer)
-S3method(buffer,numeric)
-S3method(buffer,raw)
-S3method(csv_table_reader,"arrow::csv::TableReader")
-S3method(csv_table_reader,"arrow::io::InputStream")
-S3method(csv_table_reader,character)
-S3method(csv_table_reader,default)
-S3method(dim,"arrow::RecordBatch")
-S3method(dim,"arrow::Table")
-S3method(json_table_reader,"arrow::io::InputStream")
-S3method(json_table_reader,"arrow::json::TableReader")
-S3method(json_table_reader,character)
-S3method(json_table_reader,default)
-S3method(length,"arrow::Array")
-S3method(names,"arrow::RecordBatch")
-S3method(parquet_file_reader,"arrow::io::RandomAccessFile")
-S3method(parquet_file_reader,character)
-S3method(parquet_file_reader,raw)
+S3method("!=",Object)
+S3method("==",Array)
+S3method("==",DataType)
+S3method("==",Field)
+S3method("==",Message)
+S3method("==",RecordBatch)
+S3method("==",Schema)
+S3method(as.data.frame,RecordBatch)
+S3method(as.data.frame,Table)
+S3method(as.raw,Buffer)
+S3method(dim,RecordBatch)
+S3method(dim,Table)
+S3method(length,Array)
+S3method(names,RecordBatch)
 S3method(print,"arrow-enum")
-S3method(read_message,"arrow::io::InputStream")
-S3method(read_message,"arrow::ipc::MessageReader")
+S3method(read_message,InputStream)
+S3method(read_message,MessageReader)
 S3method(read_message,default)
-S3method(read_record_batch,"arrow::Buffer")
-S3method(read_record_batch,"arrow::io::InputStream")
-S3method(read_record_batch,"arrow::ipc::Message")
+S3method(read_record_batch,Buffer)
+S3method(read_record_batch,InputStream)
+S3method(read_record_batch,Message)
 S3method(read_record_batch,raw)
-S3method(read_schema,"arrow::Buffer")
-S3method(read_schema,"arrow::io::InputStream")
-S3method(read_schema,"arrow::ipc::Message")
+S3method(read_schema,Buffer)
+S3method(read_schema,InputStream)
+S3method(read_schema,Message)
 S3method(read_schema,raw)
-S3method(read_table,"arrow::ipc::RecordBatchFileReader")
-S3method(read_table,"arrow::ipc::RecordBatchStreamReader")
+S3method(read_table,RecordBatchFileReader)
+S3method(read_table,RecordBatchStreamReader)
 S3method(read_table,character)
 S3method(read_table,raw)
-S3method(type,"arrow::Array")
-S3method(type,"arrow::ChunkedArray")
-S3method(type,"arrow::Column")
+S3method(type,Array)
+S3method(type,ChunkedArray)
+S3method(type,Column)
 S3method(type,default)
-S3method(write_arrow,"arrow::ipc::RecordBatchWriter")
+S3method(write_arrow,RecordBatchWriter)
 S3method(write_arrow,character)
 S3method(write_arrow,raw)
-S3method(write_feather,"arrow::RecordBatch")
-S3method(write_feather,data.frame)
-S3method(write_feather,default)
-S3method(write_feather_RecordBatch,"arrow::io::OutputStream")
-S3method(write_feather_RecordBatch,character)
-S3method(write_feather_RecordBatch,default)
+export(Array)
+export(Buffer)
 export(BufferOutputStream)
 export(BufferReader)
+export(ChunkedArray)
 export(CompressedInputStream)
 export(CompressedOutputStream)
 export(CompressionType)
 export(DateUnit)
 export(FeatherTableReader)
 export(FeatherTableWriter)
+export(Field)
 export(FileMode)
 export(FileOutputStream)
 export(FixedSizeBufferWriter)
+export(MemoryMappedFile)
 export(MessageReader)
 export(MessageType)
 export(MockOutputStream)
+export(ParquetFileReader)
+export(ParquetReaderProperties)
+export(RandomAccessFile)
 export(ReadableFile)
 export(RecordBatchFileReader)
 export(RecordBatchFileWriter)
 export(RecordBatchStreamReader)
 export(RecordBatchStreamWriter)
+export(Schema)
 export(StatusCode)
+export(Table)
 export(TimeUnit)
 export(Type)
-export(array)
 export(arrow_available)
 export(bool)
 export(boolean)
@@ -150,8 +110,6 @@ export(mmap_open)
 export(null)
 export(num_range)
 export(one_of)
-export(parquet_arrow_reader_properties)
-export(parquet_file_reader)
 export(read_arrow)
 export(read_csv_arrow)
 export(read_delim_arrow)
@@ -168,7 +126,6 @@ export(schema)
 export(starts_with)
 export(string)
 export(struct)
-export(table)
 export(time32)
 export(time64)
 export(timestamp)
@@ -180,7 +137,6 @@ export(uint8)
 export(utf8)
 export(write_arrow)
 export(write_feather)
-export(write_feather_RecordBatch)
 export(write_parquet)
 importFrom(R6,R6Class)
 importFrom(Rcpp,sourceCpp)