Fix toc vignettes and build pkgdown again - minor typos (ropensci/sof…

…tware-review#619)

R/qk_to_latlong_functions.R

@@ -7,7 +7,7 @@
 #' Converting latitude/longitude coordinates into a QuadKey 
 #' and then back to latitude/longitude won't yield identical values, 
 #' unless the initial latitude/longitude coordinates 
-#' correspond to the upper-left Quadkey's pixel and tile XY coordinates
+#' correspond to the upper-left QuadKey's pixel and tile XY coordinates
 #' at the same zoom level. 
 #'  
 #' Understanding this distinction is crucial for 
@@ -137,7 +137,7 @@ tileXY_to_pixelXY <- function(tileX, tileY) {
 #' Converting latitude/longitude coordinates into a QuadKey 
 #' and then back to latitude/longitude won't yield identical values, 
 #' unless the initial latitude/longitude coordinates 
-#' correspond to the upper-left Quadkey's pixel and tile XY coordinates
+#' correspond to the upper-left QuadKey's pixel and tile XY coordinates
 #' at the same zoom level. 
 #'  
 #' Understanding this distinction is crucial for 
@@ -176,7 +176,8 @@ pixelXY_to_latlong <- function(pixelX, pixelY, zoom) {
 
   # Check if pixelX and pixelY are within the valid range
   max_pixel_value <- mapsize(zoom) - 1
-  if (pixelX < 0 | pixelX > max_pixel_value | pixelY < 0 | pixelY > max_pixel_value) {
+  if (pixelX < 0 | pixelX > max_pixel_value |
+      pixelY < 0 | pixelY > max_pixel_value) {
     stop(paste(
       "Invalid pixelX or pixelY values.",
       "They should be within the range [0, (256*2^zoom) - 1]."

R/regular_grid.R

@@ -1,5 +1,4 @@
 #' Converts a incomplete QuadKey `sf` POINT data.frame into a regular grid.
-#' Output: `sf` POINT data.frame
 #'
 #' @description This function completes `sf` POINT data.frame grid of QuadKeys 
 #' using the bounding box of the data provided.
@@ -78,11 +77,9 @@ regular_qk_grid <- function(data) {
 
 
 
-#' Add the rows needed to complete a regular QuadKey grid 
+#' Add the rows needed to complete a regular QuadKey polygon grid 
 #' derived from the bounding box of the `quadkey` column of a data.frame.
-#' Output: `sf` POLYGON data.frame
 #' 
-#'
 #' @description
 #' This function estimates the bounding box of the quadkeys given in the 
 #' quadkey column and adds rows to complete the quadkeys and the geometry 
@@ -135,9 +132,8 @@ add_regular_polygon_grid <- function(data){
 }
 
 
-#' Get a data.frame representing a regular QuadKey grid 
-#' derived from the bounding box of the `quadkey` column of a data.frame.
-#' Output: `sf` POLYGON data.frame
+#' Get regular QuadKey polygon grid derived from 
+#' the bounding box of the `quadkey` column of a data.frame.
 #' 
 #' @description
 #' This function estimates the bounding box of the QuadKeys given in the 
@@ -151,7 +147,7 @@ add_regular_polygon_grid <- function(data){
 #'
 #' @param data A data.frame with a `quadkey` column.
 #'
-#'' @return A list with three elements:
+#' @return A list with three elements:
 #' * `data` An `sf` POLYGON data.frame with all the QuadKeys within
 #' the bounding box of the `quadkey` column of a data.frame.
 #' Only the columns `quadkey`, `tileX`, `tileY` and `geometry` are returned.
@@ -162,7 +158,7 @@ add_regular_polygon_grid <- function(data){
 #'
 #' @examples
 #' 
-#' # daya file
+#' # data file
 #' path <- paste0(system.file("extdata", package = 'quadkeyr'),
 #'                              "/cityA_2020_04_15_0000.csv")
 #' data <- read.csv(path)

README.Rmd

@@ -17,6 +17,7 @@ knitr::opts_chunk$set(
 
 <!-- badges: start -->
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![test-coverage](https://github.com/Fernandez-Lab-WSU/quadkeyr/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/Fernandez-Lab-WSU/quadkeyr/actions/workflows/test-coverage.yaml) [![R-CMD-check](https://github.com/Fernandez-Lab-WSU/quadkeyr/actions/workflows/check-standard.yaml/badge.svg)](https://github.com/Fernandez-Lab-WSU/quadkeyr/actions/workflows/check-standard.yaml) [![Codecov](https://img.shields.io/codecov/c/github/Fernandez-Lab-WSU/quadkeyr)](https://codecov.io/gh/Fernandez-Lab-WSU/quadkeyr)
+[![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/619_status.svg)](https://github.com/ropensci/software-review/issues/619)
 <!-- badges: end -->
 
 ⚠️ This package is under review