Skip to content

Commit ff6b19d

Browse files
committed
adjust a few sentences, skip-ci
1 parent 6d04c2b commit ff6b19d

File tree

2 files changed

+6
-34
lines changed

2 files changed

+6
-34
lines changed

README.Rmd

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The goal of `osmextract` is to make it easier for people to access OpenStreetMap
3030
OSM data is the premier source of freely available, community created geographic data worldwide.
3131
We aim to enable you to extract it for data-driven work in the public interest.
3232

33-
`osmextract` matches, downloads, converts and imports bulk OSM data hosted by providers such as [Geofabrik GmbH](http://download.geofabrik.de) and [bbbike](https://download.bbbike.org/osm/).
33+
`osmextract` matches, downloads, converts, and imports bulk OSM data hosted by providers such as [Geofabrik GmbH](http://download.geofabrik.de) and [bbbike](https://download.bbbike.org/osm/).
3434
For information on alternative providers and how to add them see the [providers vignette](https://docs.ropensci.org/osmextract/articles/providers.html).
3535

3636
## Why osmextract?
@@ -189,16 +189,7 @@ You can always check the default `download_directory` used by this package with:
189189
oe_download_directory()
190190
```
191191

192-
<!-- The following section was removed since now oe_download sets the timeout value. See https://github.com/ropensci/osmextract/issues/222 -->
193-
194-
<!-- ## Troubleshooting -->
195-
196-
<!-- Depending on the `.pbf` file selected and your connection speed, you may experience an error stating `Timeout of 60 seconds was reached`. -->
197-
<!-- If so, before calling `oe_get()`, you can adjust the timeout using `options(timeout = 300)`, choosing an appropriate value. -->
198-
<!-- This setting affects all calls to [download.file()](https://www.rdocumentation.org/packages/utils/versions/3.6.2/topics/download.file), so you may need to reset it for the rest of your script. -->
199-
200-
<!-- If you need to update an existing `.pbf` file or replace an incomplete extract, you can use the argument `force_download`, i.e `oe_get("some-place", force_download = TRUE)`. -->
201-
<!-- Check `?oe_get` and `?oe_download` for more details. -->
192+
The `force_download` argument can be used to refresh OSM extracts already present in the download directory. See also `oe_update()`and the introductory vignette for more details.
202193

203194
## Next steps
204195

@@ -218,7 +209,6 @@ See the [Introducing osmextract vignette](https://docs.ropensci.org/osmextract/a
218209

219210
## Other approaches
220211

221-
<!-- todo: add links to other packages -->
222212
- [osmdata](https://github.com/ropensci/osmdata) is an R package for importing small datasets directly from OSM servers
223213
- [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 from/to the OpenStreetMap database including map data as well as map notes, GPS traces, changelogs, and users data.
224214
- [geofabrik](https://cran.r-project.org/package=geofabrik) is an R package to download OSM data from [Geofabrik](https://download.geofabrik.de/)
@@ -239,9 +229,3 @@ We always try to build the most intuitive user interface and write the most info
239229
## Contributor Code of Conduct
240230
Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/).
241231
By contributing to this project, you agree to abide by its terms.
242-
243-
<!-- :) -->
244-
<!-- :) -->
245-
<!-- :) -->
246-
<!-- :) -->
247-
<!-- :) -->

README.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ premier source of freely available, community created geographic data
2424
worldwide. We aim to enable you to extract it for data-driven work in
2525
the public interest.
2626

27-
`osmextract` matches, downloads, converts and imports bulk OSM data
27+
`osmextract` matches, downloads, converts, and imports bulk OSM data
2828
hosted by providers such as [Geofabrik
2929
GmbH](http://download.geofabrik.de) and
3030
[bbbike](https://download.bbbike.org/osm/). For information on
@@ -232,13 +232,9 @@ package with:
232232
oe_download_directory()
233233
```
234234

235-
<!-- The following section was removed since now oe_download sets the timeout value. See https://github.com/ropensci/osmextract/issues/222 -->
236-
<!-- ## Troubleshooting -->
237-
<!-- Depending on the `.pbf` file selected and your connection speed, you may experience an error stating `Timeout of 60 seconds was reached`. -->
238-
<!-- If so, before calling `oe_get()`, you can adjust the timeout using `options(timeout = 300)`, choosing an appropriate value. -->
239-
<!-- This setting affects all calls to [download.file()](https://www.rdocumentation.org/packages/utils/versions/3.6.2/topics/download.file), so you may need to reset it for the rest of your script. -->
240-
<!-- If you need to update an existing `.pbf` file or replace an incomplete extract, you can use the argument `force_download`, i.e `oe_get("some-place", force_download = TRUE)`. -->
241-
<!-- Check `?oe_get` and `?oe_download` for more details. -->
235+
The `force_download` argument can be used to refresh OSM extracts
236+
already present in the download directory. See also `oe_update()`and the
237+
introductory vignette for more details.
242238

243239
## Next steps
244240

@@ -270,8 +266,6 @@ for more details.
270266

271267
## Other approaches
272268

273-
<!-- todo: add links to other packages -->
274-
275269
- [osmdata](https://github.com/ropensci/osmdata) is an R package for
276270
importing small datasets directly from OSM servers
277271
- [osmapiR](https://docs.ropensci.org/osmapiR/) is an R interface to the
@@ -314,9 +308,3 @@ have been explained better, please let us know.
314308
Please note that this package is released with a [Contributor Code of
315309
Conduct](https://ropensci.org/code-of-conduct/). By contributing to this
316310
project, you agree to abide by its terms.
317-
318-
<!-- :) -->
319-
<!-- :) -->
320-
<!-- :) -->
321-
<!-- :) -->
322-
<!-- :) -->

0 commit comments

Comments
 (0)