logo and other docs

.Rbuildignore

@@ -18,3 +18,4 @@
 ^arcgeocoder.*\.tar\.gz$
 ^arcgeocoder.*\.tgz$
 ^\.github$
+^data-raw$

CITATION.cff

@@ -26,11 +26,11 @@ preferred-citation:
     orcid: https://orcid.org/0000-0001-8457-4658
   year: '2024'
   version: 0.0.0.9000
-  url: https://dieghernan.github.io/nominatimlite/
+  url: https://dieghernan.github.io/arcgeocoder/
   abstract: Lite interface for geocoding and reverse geocoding with the ArcGIS REST
     API service <https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm>.
 repository-code: https://github.com/dieghernan/arcgeocoder
-url: https://dieghernan.github.io/nominatimlite/
+url: https://dieghernan.github.io/arcgeocoder/
 contact:
 - family-names: Hernangómez
   given-names: Diego
@@ -45,6 +45,9 @@ keywords:
 - rstats
 - r-package
 - api-wrapper
+- api-rest
+- arcgis-api
+- gis
 references:
 - type: software
   title: 'R: A Language and Environment for Statistical Computing'
@@ -95,9 +98,6 @@ references:
     email: jeroen@berkeley.edu
     orcid: https://orcid.org/0000-0002-4035-0289
   year: '2024'
-  identifiers:
-  - type: url
-    value: https://arxiv.org/abs/1403.2805
   version: '>= 1.7.0'
 - type: software
   title: testthat

CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# CONTRIBUTING
+
+## Fixing typos
+
+Small typos or grammatical errors in documentation may be edited directly using
+the GitHub web interface, so long as the changes are made in the *source* file.
+
+-   YES ✔️: you edit a roxygen comment in a `.R` file below `R/`.
+-   NO ❌: you edit an `.Rd` file below `man/`.
+
+## Prerequisites
+
+Before you make a substantial pull request, you should always file an issue and
+make sure someone from the team agrees that it's a problem. If you've found a
+bug, create an associated issue and illustrate the bug with a minimal
+[reprex](https://www.tidyverse.org/help/#reprex).
+
+## Pull request process
+
+-   We recommend that you create a Git branch for each pull request (PR).
+-   Look at the `R-CMD-check` build status before. After making changes, run
+    `devtools::check()` and ensure no new Notes, Warnings or Errors are
+    appearing.
+-   We recommend the tidyverse [style guide](http://style.tidyverse.org). We
+    also use the [styler](https://CRAN.R-project.org/package=styler) package to
+    apply these styles, but please **don't restyle code that has nothing to do
+    with your PR**.
+-   We use [roxygen2](https://cran.r-project.org/package=roxygen2).
+-   We use [testthat](https://cran.r-project.org/package=testthat).
+    Contributions with test cases included are easier to accept.
+-   For user-facing changes, add a bullet to the top of `NEWS.md` below the
+    current development version header describing the changes made followed by
+    your GitHub username, and links to relevant issue(s)/PR(s).
+
+## Prefer to Email?
+
+Email the person listed as maintainer in the `DESCRIPTION` file of this repo.
+
+Though note that private discussions over email don't help others - of course
+email is totally warranted if it's a sensitive problem of any kind.
+
+## Thanks for contributing!
+
+This contributing guide is adapted from the tidyverse contributing guide
+available at
+<https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md>

DESCRIPTION

@@ -8,7 +8,7 @@ Description: Lite interface for geocoding and reverse geocoding with the
     'ArcGIS' REST API service
     <https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm>.
 License: MIT + file LICENSE
-URL: https://dieghernan.github.io/nominatimlite/,
+URL: https://dieghernan.github.io/arcgeocoder/,
     https://github.com/dieghernan/arcgeocoder
 BugReports: https://github.com/dieghernan/arcgeocoder/issues
 Depends: 

NEWS.md

@@ -0,0 +1,3 @@
+# arcgeocoder (development version)
+
+* In-development.

R/arc_reverse_geo.R

@@ -18,7 +18,7 @@
 #' @param progressbar Logical. If `TRUE` displays a progress bar to indicate
 #'  the progress of the function.
 #' @param custom_query API-specific parameters to be used, passed as a named
-#'   list (ie. `list(featureTypes = "POI")`). See **Details**.
+#'   list (i.e. `list(featureTypes = "POI")`). See **Details**.
 #'
 #'
 #' @details

README.Rmd

@@ -13,16 +13,26 @@ knitr::opts_chunk$set(
 )
 ```
 
-# arcgeocoder
+# arcgeocoder <a href="https://dieghernan.github.io/arcgeocoder/"><img src="man/figures/logo.png" alt="arcgeocoder website" align="right" height="139"/></a>
 
 <!-- badges: start -->
+
+[![R-CMD-check](https://github.com/dieghernan/arcgeocoder/actions/workflows/check-full.yaml/badge.svg)](https://github.com/dieghernan/arcgeocoder/actions/workflows/check-full.yaml)
+[![codecov](https://codecov.io/gh/dieghernan/arcgeocoder/graph/badge.svg)](https://app.codecov.io/gh/dieghernan/arcgeocoder)
+[![r-universe](https://dieghernan.r-universe.dev/badges/arcgeocoder)](https://dieghernan.r-universe.dev/arcgeocoder)
+[![CodeFactor](https://www.codefactor.io/repository/github/dieghernan/arcgeocoder/badge)](https://www.codefactor.io/repository/github/dieghernan/arcgeocoder)
+[![Project Status: WIP – Initial development is in progress, but there has not
+yet been a stable, usable release suitable for the
+public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
+
 <!-- badges: end -->
 
 The goal of arcgeocoder is to ...
 
 ## Installation
 
-You can install the development version of arcgeocoder from [GitHub](https://github.com/) with:
+You can install the development version of arcgeocoder from
+[GitHub](https://github.com/) with:
 
 ``` r
 # install.packages("devtools")

README.md

@@ -1,9 +1,18 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# arcgeocoder
+# arcgeocoder <a href="https://dieghernan.github.io/arcgeocoder/"><img src="man/figures/logo.png" alt="arcgeocoder website" align="right" height="139"/></a>
 
 <!-- badges: start -->
+
+[![R-CMD-check](https://github.com/dieghernan/arcgeocoder/actions/workflows/check-full.yaml/badge.svg)](https://github.com/dieghernan/arcgeocoder/actions/workflows/check-full.yaml)
+[![codecov](https://codecov.io/gh/dieghernan/arcgeocoder/graph/badge.svg)](https://app.codecov.io/gh/dieghernan/arcgeocoder)
+[![r-universe](https://dieghernan.r-universe.dev/badges/arcgeocoder)](https://dieghernan.r-universe.dev/arcgeocoder)
+[![CodeFactor](https://www.codefactor.io/repository/github/dieghernan/arcgeocoder/badge)](https://www.codefactor.io/repository/github/dieghernan/arcgeocoder)
+[![Project Status: WIP – Initial development is in progress, but there
+has not yet been a stable, usable release suitable for the
+public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
+
 <!-- badges: end -->
 
 The goal of arcgeocoder is to …
@@ -32,7 +41,7 @@ library(arcgeocoder)
 <p>
 Hernangómez D (2024). <em>arcgeocoder: Geocoding with the ArcGIS REST
 API Service</em>.
-<a href="https://dieghernan.github.io/nominatimlite/">https://dieghernan.github.io/nominatimlite/</a>.
+<a href="https://dieghernan.github.io/arcgeocoder/">https://dieghernan.github.io/arcgeocoder/</a>.
 </p>
 
 A BibTeX entry for LaTeX users is
@@ -42,6 +51,6 @@ A BibTeX entry for LaTeX users is
       author = {Diego Hernangómez},
       year = {2024},
       version = {0.0.0.9000},
-      url = {https://dieghernan.github.io/nominatimlite/},
+      url = {https://dieghernan.github.io/arcgeocoder/},
       abstract = {Lite interface for geocoding and reverse geocoding with the ArcGIS REST API service <https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm>.},
     }

codemeta.json

@@ -4,7 +4,7 @@
   "identifier": "arcgeocoder",
   "description": "Lite interface for geocoding and reverse geocoding with the 'ArcGIS' REST API service <https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm>.",
   "name": "arcgeocoder: Geocoding with the 'ArcGIS' REST API Service",
-  "relatedLink": "https://dieghernan.github.io/nominatimlite/",
+  "relatedLink": "https://dieghernan.github.io/arcgeocoder/",
   "codeRepository": "https://github.com/dieghernan/arcgeocoder",
   "issueTracker": "https://github.com/dieghernan/arcgeocoder/issues",
   "license": "https://spdx.org/licenses/MIT",
@@ -14,7 +14,7 @@
     "name": "R",
     "url": "https://r-project.org"
   },
-  "runtimePlatform": "R version 4.3.2 (2023-10-31)",
+  "runtimePlatform": "R version 4.3.2 (2023-10-31 ucrt)",
   "author": [
     {
       "@type": "Person",
@@ -105,8 +105,8 @@
     "SystemRequirements": null
   },
   "applicationCategory": "cartography",
-  "keywords": ["r", "geocoding", "arcgis", "address", "reverse-geocoding", "rstats", "r-package", "api-wrapper"],
-  "fileSize": "24.378KB",
+  "keywords": ["r", "geocoding", "arcgis", "address", "reverse-geocoding", "rstats", "r-package", "api-wrapper", "api-rest", "arcgis-api", "gis"],
+  "fileSize": "114.471KB",
   "citation": [
     {
       "@type": "SoftwareSourceCode",
@@ -119,7 +119,10 @@
         }
       ],
       "name": "{arcgeocoder}: Geocoding with the {ArcGIS} {REST} {API} Service",
-      "url": "https://dieghernan.github.io/nominatimlite/"
+      "url": "https://dieghernan.github.io/arcgeocoder/"
     }
-  ]
+  ],
+  "readme": "https://github.com/dieghernan/arcgeocoder/blob/main/README.md",
+  "contIntegration": ["https://github.com/dieghernan/arcgeocoder/actions/workflows/check-full.yaml", "https://app.codecov.io/gh/dieghernan/arcgeocoder"],
+  "developmentStatus": "https://www.repostatus.org/#wip"
 }

data-raw/logo.R

@@ -0,0 +1,79 @@
+## code to prepare `logo` dataset goes here
+
+rm(list = ls())
+
+library(giscoR)
+library(dplyr)
+library(sf)
+library(ggplot2)
+library(hexSticker)
+
+mad <- gisco_get_coastallines(resolution = 60) %>%
+  st_transform("+proj=eqearth")
+mad2 <- st_buffer(mad, -20 * 1000)
+small <- !st_is_empty(mad2)
+mad2 <- mad2[small, ]
+mad <- mad[small, ]
+
+
+set.seed(1234)
+r <- st_sample(mad, 1000)
+
+max(st_coordinates(r)[2, ])
+max(st_coordinates(r))
+
+st_bbox(mad)
+
+## Section----
+
+
+
+df1 <- data.frame(
+  label = "arc",
+  lon = -3.544387,
+  lat = 40.55039
+)
+
+p1 <- st_as_sf(df1, coords = c("lon", "lat"), crs = 4326) %>% st_transform(3857)
+
+df2 <- data.frame(
+  label = "geocoder",
+  lon = -3.405387,
+  lat = 40.55039
+)
+
+p2 <- st_as_sf(df2, coords = c("lon", "lat"), crs = 4326) %>% st_transform(3857)
+
+library(showtext)
+## Loading Google fonts (http://www.google.com/fonts)
+font_add_google("Lato", "lato")
+
+font_add_google(
+  name = "Pacifico", # Nombre de la fuente en el sitio Google Fonts
+  family = "pacifico"
+) # Nombre con el que quieres llamar a la fuente
+## Automatically use showtext to render text for future devices
+showtext_auto()
+
+map <- ggplot(mad) +
+  geom_sf(fill = "#2c3e50", col = "#2c3e50", linewidth = 0.01) +
+  geom_sf(data = r, col = "#f39c12", size = 0.001) +
+  theme_void()
+
+
+
+map
+
+sticker(map,
+  s_width = 2,
+  s_height = 1.5,
+  s_x = 1,
+  s_y = 0.9,
+  p_family = "lato",
+  filename = "man/figures/logo.png",
+  h_fill = "#2c3e50",
+  h_color = "#2c3e50",
+  package = "arcgeocoder",
+  p_y = 1.57,
+  p_size = 17
+)

inst/WORDLIST

@@ -0,0 +1,9 @@
+ArcGIS
+CMD
+CodeFactor
+Geocoding
+ORCID
+WIP
+api
+codecov
+geocoding

inst/schemaorg.json

@@ -22,7 +22,7 @@
         "name": "R",
         "url": "https://r-project.org"
       },
-      "runtimePlatform": "R version 4.3.2 (2023-10-31)",
+      "runtimePlatform": "R version 4.3.2 (2023-10-31 ucrt)",
       "version": "0.0.0.9000"
     },
     {