Add return_pbf and return_gpkg arguments #253
Merged
Conversation
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
…ormat should be returned
Robinlovelace
approved these changes
May 2, 2022
| @@ -1,33 +1,42 @@ | |||
| #' Get the location of files | |||
| #' Get the path of .pbf and .gpkg files associated with an input OSM extract | |||
R/find.R
Outdated
| #' `place = "Isle of Wight"`, then the input `place` is matched with a URL of | ||
| #' a `.osm.pbf` file (via [`oe_match()`]) and the matching is performed setting a | ||
| #' pattern equal to the basename of that URL. | ||
| #' performed using `list.files()`, setting the `pattern` equal to the basename |
There was a problem hiding this comment.
#' performed using `list.files()`, setting the `pattern` argument equal to the basename
Would be even more specific, I suggest that.
| #' If there is no file in `download_directory` that can be matched with the | ||
| #' basename and `download_if_missing` parameter is equal to `TRUE`, then the | ||
| #' function tries to download and translate a new file from the chosen | ||
| #' If there is no file in the `download_directory` that can be matched with the |
R/find.R
Outdated
| #' @param ... Extra arguments that are passed to [`oe_match()`] and [`oe_get()`]. | ||
| #' Please note that you cannot modify the argument `download_only`. | ||
| #' @inheritParams oe_get | ||
| #' | ||
| #' @return A character vector of length one (or two) representing the path(s) of the | ||
| #' corresponding `.pbf` (and `.gpkg`) files. | ||
| #' `.pbf`/`.gpkg` files associated with the input `place`. |
There was a problem hiding this comment.
Maybe say what happens when both .pbf and .gpkg files are returned. Is the .pbf file path listed first? I assume so. Worth mentioning that if so.
There was a problem hiding this comment.
Actually no since the files returned by list.files are listed in alphabetical order (and .gpkg < .osm.pbf). I will add a note, thanks.
|
Thanks for the review @Robinlovelace, will merge now |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
At the moment, the function
oe_find()may returnpbforgpkgfiles without any particular constraint. This PR adds two new arguments namedreturn_pbfandreturn_gpkgto select which format should be returned/excluded.