osmapiR

osmapiR: An 'OpenStreetMap API' implementation for R - Published in JOSS (2024)

https://github.com/ropensci/osmapir

Science Score: 98.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 4 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
○
Committers with academic emails
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

openstreetmap openstreetmap-api osm osmapi r r-package

Keywords from Contributors

osm-data overpass-api make r-targetopia reproducibility targets tidyverse twitter digital-history history

Last synced: 4 months ago · JSON representation ·

Repository

An R interface to OpenStreetMap API for fetching and saving data from/to the OpenStreetMap database

Basic Info

Host: GitHub
Owner: ropensci
License: gpl-3.0
Language: R
Default Branch: main
Homepage: https://docs.ropensci.org/osmapiR/
Size: 9.78 MB

Statistics

Stars: 26
Watchers: 1
Forks: 6
Open Issues: 2
Releases: 6

Topics

openstreetmap openstreetmap-api osm osmapi r r-package

Created over 2 years ago · Last pushed 4 months ago

Metadata Files

Readme Changelog Contributing License Citation Codemeta

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# osmapiR 


[![R-CMD-check](https://github.com/ropensci/osmapiR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/osmapiR/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/ropensci/osmapiR/graph/badge.svg)](https://app.codecov.io/gh/ropensci/osmapiR)
[![CRAN checks](https://badges.cranchecks.info/worst/osmapiR.svg)](https://cran.r-project.org/web/checks/check_results_osmapiR.html)
[![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/osmapiR)](https://cran.r-project.org/package=osmapiR)
[![CRAN Downloads](https://cranlogs.r-pkg.org/badges/grand-total/osmapiR)](https://cran.r-project.org/package=osmapiR)
[![](https://badges.ropensci.org/633_status.svg)](https://github.com/ropensci/software-review/issues/633)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.07151/status.svg)](https://doi.org/10.21105/joss.07151)


An R interface to the [OpenStreetMap API v0.6](https://wiki.openstreetmap.org/wiki/API_v0.6) for fetching and saving raw
geodata from/to the OpenStreetMap database. This package allows access to OSM maps data as well as map notes, GPS
traces, changelogs, and users data. `osmapiR` enables editing or exploring the history of OSM objects, and is not
intended to access OSM map data for other purposes. See [Related packages](#related-packages) for other packages to
access OSM map data.

  
> [!IMPORTANT]  
> You are responsible for following the [API Usage Policy](https://operations.osmfoundation.org/policies/api/).
> You can modify the user agent of the requests by setting the option `osmapir.user_agent`:
> 
> ```r
> options(osmapir.user_agent = "my new user agent")
> ```
> 
> Respect and follow the
> [standards and conventions](https://wiki.openstreetmap.org/wiki/Editing_Standards_and_Conventions) of the
> OpenStreetMap community. If you plan to do automated edits, check the
> [Automated Edits code of conduct](https://wiki.openstreetmap.org/wiki/Automated_Edits_code_of_conduct).


## Installation

To install latest CRAN version:

``` r
install.packages("osmapiR")
```

You can install the development version of osmapiR from [GitHub](https://github.com) with:

``` r
# install.packages("remotes")
remotes::install_github("ropensci/osmapiR") # Without vignettes

## With vignettes (also accessible at https://docs.ropensci.org/osmapiR/ > Articles)
# install.packages("rmarkdown") # Needed to build vignettes.
remotes::install_github("ropensci/osmapiR", build_vignettes = TRUE)
```


## Get started

For an overview of the functions, check `?osmapiR-package` or the
[web](https://docs.ropensci.org/osmapiR/reference/index.html).

For basic examples, check
[`vignette("osmapiR", package="osmapiR")`](https://docs.ropensci.org/osmapiR/articles/osmapiR.html).


## Related packages

* [osmdata](https://cran.r-project.org/package=osmdata) implements the Overpass API to query data from OSM.
* [osmextract](https://cran.r-project.org/package=osmextract) matches, downloads, converts, and imports bulk OSM data
  (`.pbf` files).
* [OpenStreetMap](https://cran.r-project.org/package=OpenStreetMap) accesses high resolution raster maps using the
  OpenStreetMap protocol.
  
`osmapiR` is the only package to access other OSM data than the maps data (map notes, GPS traces, changelogs and
users). It is also useful to get the history of the OSM objects and is the only package that allows editing and
upload any kind of data.

To access OSM map data for purposes other than editing or exploring the history of objects, it may be better to use
other packages that implement the Overpass API ([osmdata](https://cran.r-project.org/package=osmdata)) or
that works with `.pbf` files ([osmextract](https://cran.r-project.org/package=osmextract)).


## Code of Conduct



Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). 
By contributing to this project, you agree to abide by its terms.

Owner

Name: rOpenSci
Login: ropensci
Kind: organization
Email: info@ropensci.org
Location: Berkeley, CA

Website: https://ropensci.org/
Twitter: rOpenSci
Repositories: 307
Profile: https://github.com/ropensci

JOSS Publication

osmapiR: An 'OpenStreetMap API' implementation for R

Published

September 04, 2024

DOI

10.21105/joss.07151

Volume 9, Issue 101, Page 7151

Authors

Joan Maspons

Independent researcher, Catalonia

Editor

Arfon Smith

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Maspons
  given-names: Joan
  orcid: "https://orcid.org/0000-0003-2286-8727"
doi: 10.32614/CRAN.package.osmapiR
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Maspons
    given-names: Joan
    orcid: "https://orcid.org/0000-0003-2286-8727"
  date-published: 2024-09-04
  doi: 10.21105/joss.07151
  issn: 2475-9066
  issue: 101
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 7151
  title: "osmapiR: An 'OpenStreetMap API' implementation for R"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.07151"
  volume: 9
title: "osmapiR: An 'OpenStreetMap API' implementation for R"

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "osmapiR",
  "description": "Interface to 'OpenStreetMap API' for fetching and saving data from/to the 'OpenStreetMap' database (<https://wiki.openstreetmap.org/wiki/API_v0.6>).",
  "name": "osmapiR: 'OpenStreetMap' API",
  "relatedLink": [
    "https://docs.ropensci.org/osmapiR/",
    "https://CRAN.R-project.org/package=osmapiR"
  ],
  "codeRepository": "https://github.com/ropensci/osmapiR",
  "issueTracker": "https://github.com/ropensci/osmapiR/issues",
  "license": "https://spdx.org/licenses/GPL-3.0",
  "version": "0.2.4",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.5.1 (2025-06-13)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Joan",
      "familyName": "Maspons",
      "email": "joanmaspons@gmail.com",
      "@id": "https://orcid.org/0000-0003-2286-8727"
    }
  ],
  "copyrightHolder": [
    {
      "@type": "Person",
      "givenName": "Joan",
      "familyName": "Maspons",
      "email": "joanmaspons@gmail.com",
      "@id": "https://orcid.org/0000-0003-2286-8727"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Joan",
      "familyName": "Maspons",
      "email": "joanmaspons@gmail.com",
      "@id": "https://orcid.org/0000-0003-2286-8727"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "httptest2",
      "name": "httptest2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=httptest2"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "httpuv",
      "name": "httpuv",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=httpuv"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "sf",
      "name": "sf",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=sf"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "curl",
      "name": "curl",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=curl"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "httr2",
      "name": "httr2",
      "version": ">= 1.0.6",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=httr2"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "xml2",
      "name": "xml2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=xml2"
    },
    "SystemRequirements": null
  },
  "keywords": [
    "openstreetmap",
    "OSM",
    "openstreetmap-api",
    "osmapi",
    "API",
    "osm",
    "r",
    "r-package"
  ],
  "fileSize": "14154.876KB",
  "citation": [
    {
      "@type": "ScholarlyArticle",
      "datePublished": "2024",
      "author": [
        {
          "@type": "Person",
          "givenName": "Joan",
          "familyName": "Maspons",
          "email": "joanmaspons@gmail.com",
          "@id": "https://orcid.org/0000-0003-2286-8727"
        }
      ],
      "name": "osmapiR: An 'OpenStreetMap API' implementation for R",
      "identifier": "10.21105/joss.07151",
      "description": "R package version 0.2.4",
      "pagination": "7151",
      "@id": "https://doi.org/10.21105/joss.07151",
      "sameAs": "https://doi.org/10.21105/joss.07151",
      "isPartOf": {
        "@type": "PublicationIssue",
        "issueNumber": "101",
        "datePublished": "2024",
        "isPartOf": {
          "@type": [
            "PublicationVolume",
            "Periodical"
          ],
          "volumeNumber": "9",
          "name": "Journal of Open Source Software"
        }
      }
    }
  ],
  "releaseNotes": "https://github.com/ropensci/osmapiR/blob/master/NEWS.md",
  "readme": "https://github.com/ropensci/osmapiR/blob/main/README.md",
  "contIntegration": [
    "https://github.com/ropensci/osmapiR/actions/workflows/R-CMD-check.yaml",
    "https://app.codecov.io/gh/ropensci/osmapiR"
  ],
  "developmentStatus": "https://www.repostatus.org/#active",
  "review": {
    "@type": "Review",
    "url": "https://github.com/ropensci/software-review/issues/633",
    "provider": "https://ropensci.org"
  }
}

GitHub Events

Total

Create event: 11
Release event: 3
Issues event: 7
Watch event: 13
Delete event: 8
Issue comment event: 4
Push event: 36
Pull request review event: 5
Pull request review comment event: 4
Pull request event: 17
Fork event: 3

Last Year

Create event: 11
Release event: 3
Issues event: 7
Watch event: 13
Delete event: 8
Issue comment event: 4
Push event: 36
Pull request review event: 5
Pull request review comment event: 4
Pull request event: 17
Fork event: 3

Committers

Last synced: 5 months ago

All Time

Total Commits: 362
Total Committers: 6
Avg Commits per committer: 60.333
Development Distribution Score (DDS): 0.028

Past Year

Commits: 47
Committers: 3
Avg Commits per committer: 15.667
Development Distribution Score (DDS): 0.085

Top Committers

Name	Email	Commits
Joan Maspons	j**s@g**m	352
Hadley Wickham	h**m@g**m	3
Carlos Cámara	c**a@g**m	3
Maëlle Salmon	m**n@y**e	2
Neal Richardson	n**n@g**m	1
Jeroen Ooms	j**s@g**m	1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 24
Total pull requests: 41
Average time to close issues: 19 days
Average time to close pull requests: 3 days
Total issue authors: 3
Total pull request authors: 6
Average comments per issue: 0.58
Average comments per pull request: 0.8
Merged pull requests: 40
Bot issues: 6
Bot pull requests: 0

Past Year

Issues: 5
Pull requests: 6
Average time to close issues: 2 days
Average time to close pull requests: 2 days
Issue authors: 2
Pull request authors: 3
Average comments per issue: 0.0
Average comments per pull request: 0.67
Merged pull requests: 6
Bot issues: 3
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

jmaspons (12)
github-actions[bot] (4)

Pull Request Authors

jmaspons (43)
maelle (4)
hadley (3)
ccamara (2)
jeroen (2)
nealrichardson (1)

Top Labels

Issue Labels

API updates (1)

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 358 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 5
Total maintainers: 1

cran.r-project.org: osmapiR

'OpenStreetMap' API

Homepage: https://docs.ropensci.org/osmapiR/
Documentation: http://cran.r-project.org/web/packages/osmapiR/osmapiR.pdf
License: GPL (≥ 3)
Latest release: 0.2.4
published 4 months ago

Versions: 5
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 358 Last month

Rankings

Dependent packages count: 28.6%

Dependent repos count: 35.3%

Average: 50.1%

Downloads: 86.5%

Maintainers (1)

joanmaspons@gmail.com

Last synced: 4 months ago

Dependencies

DESCRIPTION cran

httr2 * imports
xml2 * imports
httptest2 * suggests
testthat >= 3.0.0 suggests

.github/workflows/R-CMD-check.yaml actions

actions/checkout v3 composite
r-lib/actions/check-r-package v2 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/pkgdown.yaml actions

JamesIves/github-pages-deploy-action v4.4.1 composite
actions/checkout v3 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/test-coverage.yaml actions

actions/checkout v3 composite
actions/upload-artifact v3 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

osmapiR

Science Score: 98.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.Rmd

Owner

JOSS Publication

osmapiR: An 'OpenStreetMap API' implementation for R

Authors

Editor

Tags

Citation (CITATION.cff)

CodeMeta (codemeta.json)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

cran.r-project.org: osmapiR

Rankings

Maintainers (1)

Dependencies