Skip to content

Commit

Permalink
Add osmapiR
Browse files Browse the repository at this point in the history
  • Loading branch information
@jmaspons
jmaspons committed Jul 9, 2024
1 parent 37ac0f0 commit 1c7af6a
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 43 deletions.
4 changes: 4 additions & 0 deletions README.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,10 @@ sure you understand that licence before publishing any derived datasets.
The package represents data in [`sf`](https://github.com/r-spatial/sf) format only, and only allows a single "layer" (such as points, lines, or polygons) to be read at one time.
It is nevertheless recommended over osmdata for large queries of single layers, or where relationships between layers are not important.

- [osmapiR](https://docs.ropensci.org/osmapiR/) is 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.
To access OSM map data for purposes other than editing or exploring the history of the objects, better use osmdata or osmextract packages.


## Code of Conduct

Expand Down
65 changes: 22 additions & 43 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,11 @@ To load the package and check the version:
``` r
library (osmdata)
#> Data (c) OpenStreetMap contributors, ODbL 1.0. https://www.openstreetmap.org/copyright
```

``` r
packageVersion ("osmdata")
#> [1] '0.2.2'
#> [1] '0.2.5.17'
```

## Usage
Expand Down Expand Up @@ -130,8 +133,11 @@ boxes:
b <- getbb ("bangalore", format_out = "polygon")
class (b)
#> [1] "matrix" "array"
```

``` r
head (b [[1]])
#> [1] 77.4601
#> [1] 77.46005
```

### Features
Expand Down Expand Up @@ -232,7 +238,6 @@ function. Full package functionality is described on the

``` r
citation ("osmdata")
#>
#> To cite osmdata in publications use:
#>
#> Mark Padgham, Bob Rudis, Robin Lovelace, Maëlle Salmon (2017).
Expand Down Expand Up @@ -278,6 +283,15 @@ understand that licence before publishing any derived datasets.
over osmdata for large queries of single layers, or where
relationships between layers are not important.

- [osmapiR](https://docs.ropensci.org/osmapiR/) is 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. To access OSM map data for purposes
other than editing or exploring the history of the objects, better
use osmdata or osmextract packages.

## Code of Conduct

Please note that this package is released with a [Contributor Code of
Expand All @@ -286,18 +300,19 @@ project, you agree to abide by its terms.

## Contributors



<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

All contributions to this project are gratefully acknowledged using the [`allcontributors` package](https://github.com/ropenscilabs/allcontributors) following the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome!
All contributions to this project are gratefully acknowledged using the
[`allcontributors`
package](https://github.com/ropenscilabs/allcontributors) following the
[all-contributors](https://allcontributors.org) specification.
Contributions of any kind are welcome!

### Code

<table>

<tr>
<td align="center">
<a href="https://github.com/mpadge">
Expand Down Expand Up @@ -342,8 +357,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/commits?author=elipousson">elipousson</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/espinielli">
Expand Down Expand Up @@ -388,8 +401,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/commits?author=ec-nebi">ec-nebi</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/Tazinho">
Expand Down Expand Up @@ -434,8 +445,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/commits?author=stragu">stragu</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/patperu">
Expand Down Expand Up @@ -480,8 +489,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/commits?author=danstowell">danstowell</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/ccamara">
Expand All @@ -496,14 +503,11 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/commits?author=brry">brry</a>
</td>
</tr>

</table>


### Issue Authors

<table>

<tr>
<td align="center">
<a href="https://github.com/karpfen">
Expand Down Expand Up @@ -548,8 +552,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/issues?q=is%3Aissue+author%3Abeingalink">beingalink</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/yaakovfeldman">
Expand Down Expand Up @@ -594,8 +596,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/issues?q=is%3Aissue+author%3Aprokulski">prokulski</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/waholulu">
Expand Down Expand Up @@ -640,8 +640,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/issues?q=is%3Aissue+author%3Aloreabad6">loreabad6</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/slow-data">
Expand Down Expand Up @@ -686,8 +684,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/issues?q=is%3Aissue+author%3Apolettif">polettif</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/marcusyoung">
Expand Down Expand Up @@ -732,8 +728,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/issues?q=is%3Aissue+author%3Adipenpatel235">dipenpatel235</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/robitalec">
Expand Down Expand Up @@ -778,8 +772,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/issues?q=is%3Aissue+author%3AAlbertRapp">AlbertRapp</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/dmag-ir">
Expand Down Expand Up @@ -824,8 +816,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/issues?q=is%3Aissue+author%3Amooibroekd">mooibroekd</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/xiaofanliang">
Expand Down Expand Up @@ -858,14 +848,11 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/issues?q=is%3Aissue+author%3ARegularnaMatrica">RegularnaMatrica</a>
</td>
</tr>

</table>


### Issue Contributors

<table>

<tr>
<td align="center">
<a href="https://github.com/sckott">
Expand Down Expand Up @@ -910,8 +897,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/issues?q=is%3Aissue+commenter%3Acboettig">cboettig</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/prise6">
Expand Down Expand Up @@ -956,8 +941,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/issues?q=is%3Aissue+commenter%3ARobsteranium">Robsteranium</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/assignUser">
Expand All @@ -972,13 +955,9 @@ All contributions to this project are gratefully acknowledged using the [`allcon
<a href="https://github.com/ropensci/osmdata/issues?q=is%3Aissue+commenter%3Arsbivand">rsbivand</a>
</td>
</tr>

</table>

<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->



[![ropensci_footer](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org)

0 comments on commit 1c7af6a

Please sign in to comment.