docs for cran"

DESCRIPTION

@@ -2,7 +2,7 @@ Package: h3r
 Type: Package
 Title: Hexagonal Hierarchical Geospatial Indexing System
 Version: 0.1.0
-Date: 2023-09-26
+Date: 2023-09-28
 Authors@R: c(
     person("David", "Cooley", ,"dcooley@symbolix.com.au", role = c("aut", "cre")),
     person("Ray", "Shao", ,"rshao@symbolix.com.au", role = c("aut"))

R/indexing.R

@@ -8,6 +8,8 @@
 #' @param lng longitude
 #' @param resolution cell resolution
 #'
+#' @return vector giving the H3 cell for each input lat/lng pair, at the given resolution
+#'
 #' @examples
 #'
 #' latLngToCell(

R/inspection.R

@@ -113,6 +113,9 @@ isPentagon <- function(cell) {
 #'
 #' getIcosahedronFaces(cell = cellToParent(c("8cbe63562a54bff" ,"8cbe635631103ff"), c(7L, 7L)))
 #'
+#' @return list of vectors. Each list element corresponds to the input `cell` values.
+#' Each vector in a list element gives the faces intersected by the `cell`
+#'
 #' @export
 getIcosahedronFaces <- function(cell) {
   .Call(h3rGetIcosahedronFaces, cell)

R/miscellaneous.R

@@ -5,6 +5,8 @@
 #'
 #' @param deg vector of degrees
 #'
+#' @return numeric vector giving the input `deg` values as radians
+#'
 #' @examples
 #'
 #' degsToRads(deg = seq(0, 360, by = 15))
@@ -21,6 +23,8 @@ degsToRads <- function(deg) {
 #'
 #' @param rad vector of radians
 #'
+#' @return numeric vector giving the input `rad` values as degrees
+#'
 #' @examples
 #' radsToDegs(rad = seq(0, 2 * pi, by = (pi / 12) ) )
 #'
@@ -241,6 +245,8 @@ getPentagons <- function(resolution) {
 #' @param bLat vector of latitude coordinates (to)
 #' @param bLng vector of longitude coordinates (to)
 #'
+#' @return numeric vector giving the great circle distance in radians
+#'
 #' @examples
 #'
 #' greatCircleDistanceRads(
@@ -263,6 +269,7 @@ greatCircleDistanceRads <- function(aLat, aLng, bLat, bLng) {
 #'
 #' @inheritParams greatCircleDistanceRads
 #'
+#' @return numeric vector giving the great circle distance in metres
 #' @examples
 #'
 #' greatCircleDistanceM(
@@ -283,6 +290,7 @@ greatCircleDistanceM <- function(aLat, aLng, bLat, bLng) {
 #' in kilometers.
 #'
 #' @inheritParams greatCircleDistanceRads
+#' @return numeric vector giving the great circle distance in kilometres
 #'
 #' @examples
 #'

R/vertexes.R

@@ -8,6 +8,8 @@
 #' @inheritParams cellToLatLng
 #' @param vertexNum integer giving the vertex number of the index to return
 #'
+#' @return vector of vertex indexes
+#'
 #' @examples
 #'
 #' cellToVertex(
@@ -27,6 +29,10 @@ cellToVertex <- function(cell, vertexNum) {
 #'
 #' @inheritParams cellToLatLng
 #'
+#' @return list of vectors giving the vertices of each cell.
+#' Each list element corresponds to the cell index given in the `cell` argument,
+#' and each element of the vector are the cell vertexes.
+#'
 #' @examples
 #'
 #' cellToVertexes(cell = c("8cbe63562a54bff", "8cbe635631103ff") )
@@ -44,6 +50,8 @@ cellToVertexes <- function(cell) {
 #'
 #' @param vertex H3 Vertex index
 #'
+#' @return `data.frame` of the lat/lng coordinates of the input `vertex`
+#'
 #' @examples
 #'
 #' vertices <- cellToVertex(
@@ -62,10 +70,12 @@ vertexToLatLng <- function(vertex) {
 
 #' Is Valid Vertex
 #'
-#' Returns 1 if the given index represents a valid H3 vertex
+#' Tests if the given vertex is a valid H3 vertex
 #'
 #' @inheritParams vertexToLatLng
 #'
+#' @return returns 1 if the given index is a valid H3 vertex
+#'
 #' @examples
 #'
 #' isValidVertex(vertex = c("24cbe63562a549ff", "abc"))