Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the use of the input query as character strings #349

Merged
merged 3 commits into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: osmdata
Title: Import 'OpenStreetMap' Data as Simple Features or Spatial Objects
Version: 0.2.5.025
Version: 0.2.5.026
Authors@R: c(
person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre")),
person("Bob", "Rudis", role = "aut"),
Expand Down
6 changes: 3 additions & 3 deletions R/get-osmdata-df.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
#'
#' @inheritParams osmdata_sp
#' @param q An object of class `overpass_query` constructed with
#' \link{opq} and \link{add_osm_feature}. May be be omitted,
#' in which case the attributes of the \link{data.frame} will not include
#' the query.
#' \link{opq} and \link{add_osm_feature} or a string with a valid query.
jmaspons marked this conversation as resolved.
Show resolved Hide resolved
#' May be be omitted, in which case the attributes of the \link{data.frame}
#' will not include the query.
#' @param stringsAsFactors Should character strings in the 'data.frame' be
#' coerced to factors?
#' @return A `data.frame` with id, type and tags of the the objects from the
Expand Down
9 changes: 4 additions & 5 deletions R/get-osmdata-sp.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@
#' format.
#'
#' @param q An object of class `overpass_query` constructed with
#' \link{opq} and \link{add_osm_feature}. May be be omitted,
#' in which case the \link{osmdata} object will not include the
#' query.
#' \link{opq} and \link{add_osm_feature} or a string with a valid query.
#' May be be omitted, in which case the \link{osmdata} object will not
#' include the query.
#' @param doc If missing, `doc` is obtained by issuing the overpass query,
#' `q`, otherwise either the name of a file from which to read data,
#' or an object of class \pkg{xml2} returned from
#' \link{osmdata_xml}.
#' or an object of class \pkg{xml2} returned from \link{osmdata_xml}.
#' @param quiet suppress status messages.
#'
#' @return An object of class `osmdata` with the OSM components (points, lines,
Expand Down
2 changes: 1 addition & 1 deletion R/get-osmdata-xml.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#' or a raw vector.
#'
#' @param q An object of class `overpass_query` constructed with
#' \link{opq} and \link{add_osm_feature}.
#' \link{opq} and \link{add_osm_feature} or a string with a valid query.
#' @param filename If given, OSM data are saved to the named file
#' @param quiet suppress status messages.
#' @param encoding Unless otherwise specified XML documents are assumed to be
Expand Down
9 changes: 4 additions & 5 deletions man/osmdata_data_frame.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 4 additions & 5 deletions man/osmdata_sc.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 4 additions & 5 deletions man/osmdata_sf.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 4 additions & 5 deletions man/osmdata_sp.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/osmdata_xml.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading