Document the use of the input query as character strings

DESCRIPTION

@@ -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"),

R/get-osmdata-df.R

@@ -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.
+#'      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

R/get-osmdata-sp.R

@@ -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,

R/get-osmdata-xml.R

@@ -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