-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #56 from ropensci/joss
JOSS article openjournals/joss-reviews#7151
- Loading branch information
Showing
10 changed files
with
192 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| name: Draft PDF | ||
| on: | ||
| push: | ||
| paths: | ||
| - paper.md | ||
| - paper.bib | ||
| - .github/workflows/draft-pdf.yml | ||
|
|
||
| jobs: | ||
| paper: | ||
| runs-on: ubuntu-latest | ||
| name: Paper Draft | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Build draft PDF | ||
| uses: openjournals/openjournals-draft-action@master | ||
| with: | ||
| journal: joss | ||
| # This should be the path to the paper within your repo. | ||
| paper-path: paper.md | ||
| - name: Upload | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: paper | ||
| # This is the output path where Pandoc will write the compiled | ||
| # PDF. Note, this should be the same directory as the input | ||
| # paper.md | ||
| path: paper.pdf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| Type: Package | ||
| Package: osmapiR | ||
| Title: 'OpenStreetMap' API | ||
| Version: 0.1.0.9020 | ||
| Version: 0.2.0 | ||
| Authors@R: c( | ||
| person("Joan", "Maspons", , "[email protected]", role = c("aut", "cre", "cph"), | ||
| comment = c(ORCID = "0000-0003-2286-8727")), | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| @Manual{R, | ||
| title = {R: A Language and Environment for Statistical Computing}, | ||
| author = {{R Core Team}}, | ||
| organization = {R Foundation for Statistical Computing}, | ||
| address = {Vienna, Austria}, | ||
| year = {2024}, | ||
| url = {https://www.R-project.org/}, | ||
| } | ||
|
|
||
| @Manual{osmapiR, | ||
| title = {osmapiR: OpenStreetMap API}, | ||
| author = {Joan Maspons}, | ||
| note = {R package version 0.2.0 https://github.com/ropensci/osmapiR}, | ||
| year = {2024}, | ||
| url = {https://docs.ropensci.org/osmapiR/}, | ||
| doi = {10.32614/CRAN.package.osmapiR}, | ||
| } | ||
|
|
||
| @Article{osmdata, | ||
| title = {osmdata}, | ||
| author = {Mark Padgham and Bob Rudis and Robin Lovelace and Maëlle Salmon}, | ||
| journal = {Journal of Open Source Software}, | ||
| year = {2017}, | ||
| volume = {2}, | ||
| number = {14}, | ||
| pages = {305}, | ||
| month = {jun}, | ||
| publisher = {The Open Journal}, | ||
| url = {https://joss.theoj.org/papers/10.21105/joss.00305}, | ||
| doi = {10.21105/joss.00305}, | ||
| } | ||
|
|
||
| @Manual{osmextract, | ||
| title = {osmextract: Download and Import Open Street Map Data Extracts}, | ||
| author = {Andrea Gilardi and Robin Lovelace}, | ||
| year = {2024}, | ||
| note = {R package version 0.5.1}, | ||
| url = {https://CRAN.R-project.org/package=osmextract}, | ||
| doi = {10.32614/CRAN.package.osmextract}, | ||
| } | ||
|
|
||
| @Manual{OpenStreetMap_package, | ||
| title = {OpenStreetMap: Access to Open Street Map Raster Images}, | ||
| author = {Ian Fellows and Jan Peter Stotz}, | ||
| year = {2023}, | ||
| note = {R package version 0.4.0}, | ||
| url = {https://CRAN.R-project.org/package=OpenStreetMap}, | ||
| doi = {10.32614/CRAN.package.OpenStreetMap}, | ||
| } | ||
|
|
||
| @Article{sf, | ||
| author = {Edzer Pebesma}, | ||
| title = {{Simple Features for R: Standardized Support for Spatial Vector Data}}, | ||
| year = {2018}, | ||
| journal = {{The R Journal}}, | ||
| doi = {10.32614/RJ-2018-009}, | ||
| url = {https://doi.org/10.32614/RJ-2018-009}, | ||
| pages = {439--446}, | ||
| volume = {10}, | ||
| number = {1}, | ||
| } | ||
|
|
||
| @Manual{xml2, | ||
| title = {xml2: Parse XML}, | ||
| author = {Hadley Wickham and Jim Hester and Jeroen Ooms}, | ||
| year = {2023}, | ||
| note = {R package version 1.3.6}, | ||
| url = {https://CRAN.R-project.org/package=xml2}, | ||
| doi = {10.32614/CRAN.package.xml2}, | ||
| } | ||
|
|
||
| @article{kolb2019, | ||
| author = {Jan-Philipp Kolb}, | ||
| title = {{Using Web Services to Work with Geodata in R}}, | ||
| year = {2019}, | ||
| journal = {{The R Journal}}, | ||
| doi = {10.32614/RJ-2019-041}, | ||
| url = {https://doi.org/10.32614/RJ-2019-041}, | ||
| pages = {6--23}, | ||
| volume = {11}, | ||
| number = {2} | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| --- | ||
| title: "osmapiR: An 'OpenStreetMap API' implementation for R" | ||
| tags: | ||
| - openstreetmap | ||
| - OSM | ||
| - spatial | ||
| - R | ||
| authors: | ||
| - name: Joan Maspons | ||
| orcid: 0000-0003-2286-8727 | ||
| affiliation: 1 | ||
| # corresponding: true | ||
| affiliations: | ||
| - name: Independent researcher, Catalonia | ||
| index: 1 | ||
| date: 22 July 2024 | ||
| bibliography: paper.bib | ||
| # nocite: | | ||
| # @* | ||
| --- | ||
|
|
||
| # Summary | ||
|
|
||
| `osmapiR` [@osmapiR] is a complete implementation of the | ||
| [OpenStreetMap API](https://wiki.openstreetmap.org/wiki/API_v0.6) for `R` [@R]. | ||
| OpenStreetMap (OSM) is a global, crowdsourced geographic database licensed under the [Open Database License](https://www.openstreetmap.org/copyright). | ||
| The OSM project follows a peer production model similar to Wikipedia. | ||
|
|
||
|
|
||
| # Statement of need | ||
|
|
||
| The `osmapiR` package facilitates to retrieve all types of OSM data, including map data, map notes, GPS traces, | ||
| changelogs, and user data. | ||
| The data can be imported into R as `data.frame`, `sf` [@sf], `xml_document` [@xml2], or JSON lists. | ||
| Editing the OSM database is also supported with specific functions to send changes directly to the OSM database or to | ||
| generate and export changes in [Osmchange format](https://wiki.openstreetmap.org/wiki/OsmChange), compatible with other | ||
| editors such as JOSM. | ||
|
|
||
| `osmapiR` is the only R package that allows access to non-map OSM data (map notes, GPS traces, changelogs and users | ||
| data), as well as the ability to edit and upload any kind of data to the project. | ||
| It is also useful for obtaining the history of the OSM map objects. | ||
| The OpenStreetMap API is not intended to access objects from OSM map data for read-only purposes, as required by the | ||
| [API Usage Policy](https://operations.osmfoundation.org/policies/api/). | ||
| For such purposes, the use of `osmdata` or `osmextract` packages is recommended. | ||
| `osmdata` uses the Overpass API [@osmdata] and works well for moderated size datasets or to access objects filtered by | ||
| tags. | ||
| `osmextract` works with local `pbf` files [@osmextract] and is the recommended tool to work with big datasets. | ||
| For a review of options to access online geodata in R, including OSM data, see @kolb2019. | ||
|
|
||
|
|
||
| # References |