Merge pull request #12 from crazycapivara/develop

Develop

.gitignore

@@ -1,3 +1,4 @@
+inst/doc
 .Rhistory
 .RData
 .Rproj.user

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: h3
 Title: R bindings for H3
-Version: 0.1.1
-Date: 2019-02-01
+Version: 3.3.0
+Date: 2019-02-17
 Authors@R: person("Stefan","Kuethe", role = c("aut", "cre"), email = "[email protected]")
 Maintainer: Stefan Kuethe <[email protected]>
 Description: Provides R bindings for H3 <https://uber.github.io/h3/>,
@@ -21,5 +21,10 @@ Imports:
   tibble
 Suggests:
     sf,
-    testthat
+    testthat,
+    knitr,
+    rmarkdown,
+    leaflet,
+    dplyr
 RoxygenNote: 6.1.0
+VignetteBuilder: knitr

NEWS.md

@@ -1,3 +1,8 @@
+# h3 3.3.0
+
+* Added `pkgdown` site.
+* Added `Get started` vignette.
+
 # h3 0.1.1
 
 * Added a `NEWS.md` file to track changes to the package.

R/h3_hierachy.R

@@ -1,16 +1,16 @@
 #' Get the parent of the given hexagon at a particular resolution.
-#' @inheritParams h3_to_geo
+#' @param h3_index character scalar representing a valid H3 index
 #' @param res resolution of parent
-#' @return character
+#' @return character scalar
 #' @export
 h3_to_parent <- function(h3_index, res) {
   rcpp_h3_to_parent(h3_index, res)
 }
 
 #' Get the children of the given hexagon at a particular resolution.
-#' @inheritParams h3_to_geo
+#' @inheritParams h3_to_parent
 #' @param res resolution of children
-#' @return character
+#' @return character vector
 #' @export
 h3_to_children <- function(h3_index, res) {
   rcpp_h3_to_children(h3_index, res)

README.Rmd

@@ -44,8 +44,10 @@ Then you can run:
 git clone https://github.com/crazycapivara/h3-r.git
 pushd h3-r
 chmod +x install-h3c.sh
+# Install H3 C Library
 ./install-h3c.sh
-# R -q -e 'devtools::install()'
+# Install H3 for R
+R -q -e 'devtools::install()'
 popd
 rm -rf h3-r
 ```
@@ -95,3 +97,9 @@ h3_to_geo_boundary_sf(neighbors) %>%
 h3_set_to_multi_polygon(neighbors) %>%
   sf::st_geometry() %>% plot(col = "green")
 ```
+
+## Run tests
+
+```{r tests}
+devtools::test()
+```

README.md

@@ -34,8 +34,10 @@ Then you can run:
 git clone https://github.com/crazycapivara/h3-r.git
 pushd h3-r
 chmod +x install-h3c.sh
+# Install H3 C Library
 ./install-h3c.sh
-# R -q -e 'devtools::install()'
+# Install H3 for R
+R -q -e 'devtools::install()'
 popd
 rm -rf h3-r
 ```
@@ -79,7 +81,7 @@ h3_to_geo_sf(h3_index)
 # Get the vertices of the hexagon
 h3_to_geo_boundary(h3_index)
 #> [[1]]
-#>          [,1]      [,2]
+#>           lat       lng
 #> [1,] 37.34110 -122.0416
 #> [2,] 37.35290 -122.0340
 #> [3,] 37.36352 -122.0428
@@ -121,3 +123,18 @@ h3_set_to_multi_polygon(neighbors) %>%
 ```
 
 <img src="man/figures/README-h3-algorithms-2.png" width="400px" />
+
+Run tests
+---------
+
+``` r
+devtools::test()
+#> Loading h3
+#> Testing h3
+#> H3 hierachy: ....
+#> H3 indexing: .....
+#> H3 misc: ..
+#> H3 traversal: .....
+#> 
+#> DONE ======================================================================
+```