update docs

.Rbuildignore

@@ -3,3 +3,4 @@
 ^README-.*\.png$
 ^.*\.Rproj$
 ^\.Rproj\.user$
+^LICENSE\.md$

DESCRIPTION

@@ -13,7 +13,7 @@ Authors@R: c(person("Carl", "Boettiger",
               person("Richard", "FitzJohn", role = "ctb"))
 URL: https://github.com/cboettig/arkdb
 BugReports: https://github.com/cboettig/arkdb/issues
-License: MIT
+License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
 ByteCompile: true
@@ -25,6 +25,10 @@ Imports:
     DBI,
     readr,
     RSQLite,
-    progress
+    progress,
+    dplyr,
+    methods
 Suggests: 
-    nycflights13
+    nycflights13,
+    testthat,
+    knitr

LICENSE

@@ -0,0 +1,2 @@
+YEAR: 2018
+COPYRIGHT HOLDER: Carl Boettiger

LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2018 Carl Boettiger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

NAMESPACE

@@ -16,5 +16,6 @@ importFrom(dplyr,row_number)
 importFrom(dplyr,sql)
 importFrom(dplyr,summarise)
 importFrom(dplyr,tbl)
+importFrom(methods,is)
 importFrom(progress,progress_bar)
 importFrom(readr,read_tsv)

R/ark.R

@@ -17,6 +17,7 @@
 #' 
 #' @importFrom dbplyr src_dbi
 #' @importFrom DBI dbListTables
+#' @importFrom methods is
 #' @export
 #' 
 #' @examples 

R/unark.R

@@ -53,7 +53,7 @@ unark <- function(files, lines = 10000L, drv = RSQLite::SQLite(), ...){
 #' Unarchive a single tsv file into an existing database
 #' 
 #' @param filename a *.tsv.bz2 file to uncompress
-#' @param db a database src (`src_dbi` object from `dplyr`)
+#' @param db_con a database src (`src_dbi` object from `dplyr`)
 #' @param lines number of lines to read in a chunk. 
 #' 
 #' @return the database connection (`src_dbi`, invisibly)

tests/testthat.R

@@ -0,0 +1,4 @@
+library(testthat)
+library(arkdb)
+
+test_check("arkdb")

tests/testthat/test-arkdb.R

@@ -0,0 +1,51 @@
+## ---- echo = FALSE-------------------------------------------------------
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "README-"
+)
+
+## ----gh-installation, eval = FALSE---------------------------------------
+#> # install.packages("devtools")
+#> devtools::install_github("cboettig/arkdb")
+
+## ------------------------------------------------------------------------
+library(arkdb)
+
+# additional libraries just for this demo
+library(dbplyr)
+library(dplyr)
+library(nycflights13)
+library(fs)
+
+## ----example-------------------------------------------------------------
+db <- dbplyr::nycflights13_sqlite(".")
+
+## ------------------------------------------------------------------------
+dir <- fs::dir_create("nycflights")
+ark(db, dir)
+
+
+## ------------------------------------------------------------------------
+fs::dir_info(dir) %>% select(path, size)
+fs::file_info("nycflights13.sqlite") %>% select(path, size)
+
+
+## ------------------------------------------------------------------------
+files <- fs::dir_ls(dir, glob = "*.tsv.bz2")
+
+## ------------------------------------------------------------------------
+new_db <-  unark(files, dbname = "local.sqlite")
+
+## ------------------------------------------------------------------------
+tbl(new_db, "flights")
+
+## ----include=FALSE-------------------------------------------------------
+unlink("nycflights", TRUE)
+unlink("local.sqlite")
+unlink("nycflights13.sqlite")
+
+## dbplyr handles this automatically
+#DBI::dbDisconnect(db[[1]])
+#DBI::dbDisconnect(new_db[[1]])
+