Skip to content

Commit

Permalink
Add paper for JOSS
Browse files Browse the repository at this point in the history
  • Loading branch information
jmaspons committed Jul 15, 2024
1 parent 947ae1f commit 605fa02
Show file tree
Hide file tree
Showing 3 changed files with 119 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/draft-OpenJournal_paper-pdf.yaml
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@v3
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
50 changes: 50 additions & 0 deletions paper.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
@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/},
}

@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{kolb2019,
title={Using Web Services to Work with Geodata in R.},
author={Kolb, Jan-Philipp},
journal={The R Journa},
volume={11},
number={2},
pages={6--23},
year={2019}
}
40 changes: 40 additions & 0 deletions paper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: osmapiR
tags:
- openstreetmap
- OSM
- spatial
- R
authors:
- name: Joan Maspons
orcid: 0000-0003-2286-8727
affiliation: 1
# affiliations:
# - name: Universitat de Barcelona, Catalonia
# index: 1
date: 28 July 2024
bibliography: paper.bib
nocite: |
@*
---

# Summary

`osmapiR` is an interface to the [OpenStreetMap API](https://wiki.openstreetmap.org/wiki/API_v0.6) for fetching and
saving raw geodata from/to the OpenStreetMap database using `R` [@R].
This package allows access to OpenStreetMap maps data as well as map notes, GPS traces, changelogs, and users data.


# Statement of need

`osmapiR` is the only package to access other OpenStreetMap data than the maps data (map notes, GPS traces, changelogs
and users).
It is also useful to get the history of the OpenStreetMap objects and is the only package that allows editing and upload
any kind of data to the project.
The OpenStreetMap API is not intended to access objects from OpenStreetMap map data for read-only purposes as required
by the [API Usage Policy](https://operations.osmfoundation.org/policies/api/).
To access map objects from R, check `osmdata` to use the Overpass API [@osmdata] or `osmextract` to work with `pbf`
files [@osmextract].
See @kolb2019 for a review of the options to access online geodata in R, including OpenStreetMap.

# References

0 comments on commit 605fa02

Please sign in to comment.