|
5 | 5 | #' Contains the following functions, data, and vignettes.
|
6 | 6 | #'
|
7 | 7 | #' @section Data Functions:
|
8 |
| -#' \tabular{ll}{ |
9 |
| -#' \code{\link{extract_osm_objects}} \tab Download arbitrary OSM objects \cr |
10 |
| -#' \code{\link{connect_highways}} \tab Returns points sequentially connecting |
11 |
| -#' list of named highways \cr |
| 8 | +#' \itemize{ |
| 9 | +#' \item \code{\link{extract_osm_objects}}: Download arbitrary OSM objects |
| 10 | +#' \item \code{\link{connect_highways}}: Returns points sequentially connecting |
| 11 | +#' list of named highways |
12 | 12 | #' }
|
13 | 13 | #'
|
14 | 14 | #' @section Basic Plotting Functions (without data):
|
15 |
| -#' \tabular{ll}{ |
16 |
| -#' \code{\link{add_axes}} \tab Overlay longitudinal and latitudinal axes on plot \cr |
17 |
| -#' \code{\link{add_osm_objects}} \tab Overlay arbitrary OSM objects \cr |
18 |
| -#' \code{\link{make_osm_map}} \tab Automate map production with structures |
19 |
| -#' defined in \code{\link{osm_structures}} \cr |
20 |
| -#' \code{\link{osm_structures}} \tab Define structures and graphics schemes for |
21 |
| -#' automating map production \cr |
22 |
| -#' \code{\link{osm_basemap}} \tab Initiate a \code{ggplot2} object for an OSM |
23 |
| -#' map \cr |
24 |
| -#' \code{\link{print_osm_map}} \tab Print a map to specified graphics |
25 |
| -#' device \cr |
| 15 | +#' \itemize{ |
| 16 | +#' \item \code{\link{add_axes}}: Overlay longitudinal and latitudinal axes on plot |
| 17 | +#' \item \code{\link{add_osm_objects}}: Overlay arbitrary OSM objects |
| 18 | +#' \item \code{\link{make_osm_map}}: Automate map production with structures |
| 19 | +#' defined in \code{\link{osm_structures}} |
| 20 | +#' \item \code{\link{osm_structures}}: Define structures and graphics schemes for |
| 21 | +#' automating map production |
| 22 | +#' \item \code{\link{osm_basemap}}: Initiate a \code{ggplot2} object for an OSM |
| 23 | +#' map |
| 24 | +#' \item \code{\link{print_osm_map}}: Print a map to specified graphics |
| 25 | +#' device |
26 | 26 | #' }
|
27 | 27 | #'
|
28 | 28 | #' @section Advanced Plotting Functions (with data):
|
29 |
| -#' \tabular{ll}{ |
30 |
| -#' \code{\link{add_osm_groups}} \tab Overlay groups of objects using specified |
31 |
| -#' colour scheme \cr |
32 |
| -#' \code{\link{add_osm_surface}} \tab Overlay data surface by interpolating given |
33 |
| -#' data \cr |
34 |
| -#' \code{\link{add_colourbar}} \tab Overlay a scaled colourbar for data added |
35 |
| -#' with \code{\link{add_osm_surface}} \cr |
| 29 | +#' \itemize{ |
| 30 | +#' \item \code{\link{add_osm_groups}}: Overlay groups of objects using specified |
| 31 | +#' colour scheme |
| 32 | +#' \item \code{\link{add_osm_surface}}: Overlay data surface by interpolating |
| 33 | +#' given data |
| 34 | +#' \item \code{\link{add_colourbar}}: Overlay a scaled colourbar for data added |
| 35 | +#' with \code{\link{add_osm_surface}} |
36 | 36 | #' }
|
37 | 37 | #'
|
38 | 38 | #' @section Colour Manipulation Functions:
|
39 |
| -#' \tabular{ll}{ |
40 |
| -#' \code{\link{adjust_colours}} \tab Lighted or darken given colours by specified |
41 |
| -#' amount \cr |
42 |
| -#' \code{\link{colour_mat}} \tab Generate continuous 2D spatial matrix of |
43 |
| -#' colours \cr |
| 39 | +#' \itemize{ |
| 40 | +#' \item \code{\link{adjust_colours}}: Lighted or darken given colours by |
| 41 | +#' specified amount |
| 42 | +#' \item \code{\link{colour_mat}}: Generate continuous 2D spatial matrix of |
| 43 | +#' colours |
44 | 44 | #' }
|
45 | 45 | #'
|
46 | 46 | #' @section Other Functions:
|
47 |
| -#' \tabular{ll}{ |
48 |
| -#' \code{\link{get_bbox}} \tab return bounding box from input vector \cr |
| 47 | +#' \itemize{ |
| 48 | +#' \item \code{\link{get_bbox}}: return bounding box from input vector |
49 | 49 | #' }
|
50 | 50 | #'
|
51 | 51 | #' @section Data:
|
52 |
| -#' \tabular{ll}{ |
53 |
| -#' \code{\link{london}} \tab OSM Data from a small portion of central London \cr |
| 52 | +#' \itemize{ |
| 53 | +#' \item \code{\link{london}}: OSM Data from a small portion of central London |
54 | 54 | #' }
|
55 | 55 | #'
|
56 | 56 | #' @section Vignettes:
|
57 |
| -#' \tabular{ll}{ |
58 |
| -#' \code{basic-maps} \tab Describes basics of downloading data and making custom |
59 |
| -#' maps \cr |
60 |
| -#' \code{data-maps} \tab Describes how map elements can be coloured according to |
61 |
| -#' user-provided data, whether categorical or continuous \cr |
| 57 | +#' \itemize{ |
| 58 | +#' \item \code{basic-maps}: Describes basics of downloading data and making |
| 59 | +#' custom maps |
| 60 | +#' \item \code{data-maps}: Describes how map elements can be coloured according |
| 61 | +#' to user-provided data, whether categorical or continuous |
62 | 62 | #' }
|
63 | 63 | #'
|
64 | 64 | #' @name osmplotr
|
|
0 commit comments