further clean of man entries

Author: mpadge

R/add-axes.R

@@ -10,7 +10,7 @@
 #' labels (lower values increase transparency).
 #' @param fontsize Size of axis font (in \code{ggplot2} terms; default=3).
 #' @param fontface Fontface for axis labels (1:4=plain,bold,italic,bold-italic).
-#' @param fontfamily Family of axis font (for example, `Times').
+#' @param fontfamily Family of axis font (for example, `\code{Times}').
 #' @param ... Mechanism to allow many parameters to be passed with alternative
 #' names (\code{color} for \code{colour} and \code{xyz} for \code{fontxyz}.
 #' @return Modified version of \code{map} with axes added.

R/add-osm-groups.R

@@ -4,12 +4,12 @@
 #'
 #' @param map A \code{ggplot2} object to which the grouped objects are to be
 #' added.
-#' @param obj An \code{sp} \code{SpatialPolygonsDataFrame} or
-#' \code{SpatialLinesDataFrame} (list of polygons or lines) returned by
-#' \code{\link{extract_osm_objects}}.
+#' @param obj An \code{sp} \code{SpatialPointsDataFrame},
+#' \code{SpatialPolygonsDataFrame}, or \code{SpatialLinesDataFrame} (list of
+#' polygons or lines) returned by \code{\link{extract_osm_objects}}.
 #' @param groups A list of spatial points objects, each of which contains the
 #' coordinates of points defining one group.
-#' @param cols Either a vector of >= 4 colours passed to \code{olour_mat} (if
+#' @param cols Either a vector of >= 4 colours passed to \code{colour_mat} (if
 #' \code{colmat=T}) to arrange as a 2-D map of visually distinct colours
 #' (default uses \code{rainbow} colours), or (if \code{colmat=F}), a vector of
 #' the same length as groups specifying individual colours for each.
@@ -44,7 +44,7 @@
 #' are *excluded* from the group, while those outside the smaller yet inside the
 #' bigger group are included.
 #'
-#' @seealso \code{\link{colour_mat}}.
+#' @seealso \code{\link{colour_mat}}, \code{\link{add_osm_objects}}.
 #'
 #' @examples
 #' bbox <- get_bbox (c (-0.13, 51.5, -0.11, 51.52))

R/add-osm-objects.R

@@ -6,7 +6,7 @@
 #'
 #' @param map A \code{ggplot2} object to which the objects are to be added.
 #' @param obj A spatial (\code{sp}) data frame of polygons, lines, or points,
-#' typically as returned by \code{extract_osm_objects}.
+#' typically as returned by \code{\link{extract_osm_objects}}.
 #' @param col Colour of lines or points; fill colour of polygons.
 #' @param border Border colour of polygons.
 #' @param size Size argument passed to \code{ggplot2} (polygon, path, point)

R/add-osm-surface.R

@@ -4,7 +4,7 @@
 #' generated by \code{\link{extract_osm_objects}} to a graphics object
 #' initialised with \code{\link{osm_basemap}}. The surface is spatially
 #' interpolated between the values given in \code{dat}, which has to be a matrix or
-#' \code{data.frame} of 3 colums (x, y, z), where (x,y) are (longitude,
+#' \code{data.frame} of 3 columns (x, y, z), where (x,y) are (longitude,
 #' latitude), and z are the values to be interpolated. Interpolation uses
 #' \code{spatstat::Smoothing.ppp}, which applies a Gaussian kernel smoother
 #' optimised to the given data, and is effectively non-parametric.
@@ -32,8 +32,7 @@
 #' @param shape Shape of lines or points, for details of which see
 #' \code{?ggplot::shape}. If \code{bg} is provided and \code{shape} has 2
 #' elements, the second determines the \code{shape} of the background objects.
-#' @return modified version of \code{map} (a \code{ggplot2} object) to which
-#' surface has been added
+#' @return modified version of \code{map} to which surface has been added
 #'
 #' @note 
 #' Points beyond the spatial boundary of \code{dat} are included in the surface

R/adjust-colours.R

@@ -9,8 +9,8 @@
 #' @param adj A number between -1 and 1 determining how much to lighten
 #' (positive values) or darken (negative values) the colours.
 #' @param plot If \code{TRUE}, generates a plot to allow visual comparison of
-#' original and adjusted colours
-#' @return Corresponding vector of adjusted colours (as hexadecimal strings)
+#' original and adjusted colours.
+#' @return Corresponding vector of adjusted colours (as hexadecimal strings).
 #' @export
 #'
 #' @seealso \code{\link{osm_structures}}, \code{?col2rgb}.

R/colour-mat.R

@@ -6,7 +6,7 @@
 #' @param n number of rows and columns of colour matrix (default = 10; if length
 #' 2, then dimensions of rectangle). 
 #' @param cols vector of length >= 4 of colors (example, default = \code{rainbow
-#' (4)}, or from \code{RColorBrewer}, \code{brewer.pal (4, 'Set1')}).
+#' (4)}, or \code{RColorBrewer::brewer.pal (4, 'Set1')}).
 #' \code{cols} are wrapped clockwise around the corners from top left to bottom
 #' left. 
 #' @param rotate rotates the entire colour matrix by the specified angle (in

R/extract-osm-objects.R

@@ -19,7 +19,8 @@
 #' max values, and rows of x and y values.
 #' @param verbose If \code{TRUE}, provides notification of progress.
 #'
-#' @return An \code{sp} data frame.
+#' @return Either a \code{SpatialPointsDataFrame}, \code{SpatialLinesDataFrame},
+#' or \code{SpatialPolygonsDataFrame}.
 #' @export
 #'
 #' @seealso \code{\link{add_osm_objects}}.

R/get-bbox.R

@@ -2,7 +2,7 @@
 #'
 #' Converts a string of latitudes and longitudes into a square matrix to be
 #' passed as a \code{bbox} argument (to \code{\link{extract_osm_objects}},
-#' \code{\link{osm_basemap}}, or \code{\link{make_osm_map}}.
+#' \code{\link{osm_basemap}}, or \code{\link{make_osm_map}}).
 #'
 #' @param latlon A vector of (longitude, latitude, longitude, latitude) values.
 #' @return A 2-by-2 matrix of 4 elements with columns of min and max values, and

R/make-osm-map.R

@@ -22,8 +22,9 @@
 #' \code{\link{osm_structures}}.
 #' @return List of two components: 
 #' \enumerate{
-#'   \item List of OSM structures each as \code{Spatial(Polygon/List)DataFrame}
-#'   and appended to \code{osm_data} (which is \code{NULL} by default), and 
+#'   \item List of OSM structures each as
+#'      \code{Spatial(Points/Lines/Polygons)DataFrame} and appended to
+#'      \code{osm_data} (which is \code{NULL} by default), and 
 #'   \item The \code{map} as a \code{ggplot2} object
 #' }
 #' @export

R/osm-basemap.R

@@ -10,8 +10,8 @@
 #' here to specify background colour of plot; if missing, the colour is
 #' specified by \code{bg}.
 #' @param bg Background colour of map (default = \code{gray20}) only if
-#' \code{structs} not given)
-#' @return \code{ggplot2} object containing base map
+#' \code{structs} not given).
+#' @return A \code{ggplot2} object containing the base \code{map}.
 #' @export
 #'
 #' @seealso \code{\link{add_osm_objects}}, \code{\link{make_osm_map}}.

R/osmplotr.R

@@ -6,59 +6,59 @@
 #'
 #' @section Data Functions:
 #' \tabular{ll}{
-#' \code{\link{extract_osm_objects}}\tab Download arbitrary OSM objects\cr
-#' \code{\link{connect_highways}}\tab Returns points sequentially connecting
-#' list of named highways\cr
+#' \code{\link{extract_osm_objects}} \tab Download arbitrary OSM objects \cr
+#' \code{\link{connect_highways}} \tab Returns points sequentially connecting
+#' list of named highways \cr
 #' }
 #'
 #' @section Basic Plotting Functions (without data):
 #' \tabular{ll}{
-#' \code{\link{add_axes}}\tab Overlay longitudinal and latitudinal axes on plot\cr 
-#' \code{\link{add_osm_objects}}\tab Overlay arbitrary OSM objects\cr 
-#' \code{\link{make_osm_map}}\tab Automate map production with structures
-#' defined in \code{\link{osm_structures}}\cr 
-#' \code{\link{osm_structures}}\tab Define structures and graphics schemes for
+#' \code{\link{add_axes}} \tab Overlay longitudinal and latitudinal axes on plot \cr 
+#' \code{\link{add_osm_objects}} \tab Overlay arbitrary OSM objects \cr 
+#' \code{\link{make_osm_map}} \tab Automate map production with structures
+#' defined in \code{\link{osm_structures}} \cr 
+#' \code{\link{osm_structures}} \tab Define structures and graphics schemes for
 #' automating map production \cr 
-#' \code{\link{osm_basemap}}\tab Initiate a \code{ggplot2} object for an OSM
-#' map\cr 
-#' \code{\link{print_osm_map}}\tab Print a map to specified graphics
-#' device
+#' \code{\link{osm_basemap}} \tab Initiate a \code{ggplot2} object for an OSM
+#' map \cr 
+#' \code{\link{print_osm_map}} \tab Print a map to specified graphics
+#' device \cr
 #' } 
 #'
 #' @section Advanced Plotting Functions (with data):
 #' \tabular{ll}{
-#' \code{\link{add_osm_groups}}\tab Overlay groups of objects using specified
-#' colour scheme\cr 
-#' \code{\link{add_osm_surface}}\tab Overlay data surface by interpolating given
+#' \code{\link{add_osm_groups}} \tab Overlay groups of objects using specified
+#' colour scheme \cr 
+#' \code{\link{add_osm_surface}} \tab Overlay data surface by interpolating given
 #' data \cr 
-#' \code{\link{add_colourbar}}\tab Overlay a scaled colourbar for data added
-#' with \code{\link{add_osm_surface}}\cr 
+#' \code{\link{add_colourbar}} \tab Overlay a scaled colourbar for data added
+#' with \code{\link{add_osm_surface}} \cr 
 #' }
 #'
 #' @section Colour Manipulation Functions:
 #' \tabular{ll}{
-#' \code{\link{adjust_colours}}\tab Lighted or darken given colours by specified
-#' amount\cr 
-#' \code{\link{colour_mat}}\tab Generate continuous 2D spatial matrix of
-#' colours\cr 
+#' \code{\link{adjust_colours}} \tab Lighted or darken given colours by specified
+#' amount \cr 
+#' \code{\link{colour_mat}} \tab Generate continuous 2D spatial matrix of
+#' colours \cr 
 #' }
 #'
 #' @section Other Functions:
 #' \tabular{ll}{
-#' \code{\link{get_bbox}}\tab return bounding box from input vector\cr 
+#' \code{\link{get_bbox}} \tab return bounding box from input vector \cr 
 #' }
 #'
 #' @section Data:
 #' \tabular{ll}{
-#' \code{\link{london}}\tab OSM Data from a small portion of central London\cr 
+#' \code{\link{london}} \tab OSM Data from a small portion of central London \cr 
 #' }
 #'
 #' @section Vignettes:
 #' \tabular{ll}{
-#' \code{basic-maps}\tab Describes basics of downloading data and making custom
-#' maps\cr
-#' \code{data-maps}\tab Describes how map elements can be coloured according to
-#' user-provided data, whether categorical or continuous.
+#' \code{basic-maps} \tab Describes basics of downloading data and making custom
+#' maps \cr
+#' \code{data-maps} \tab Describes how map elements can be coloured according to
+#' user-provided data, whether categorical or continuous \cr
 #' }
 #'
 #' @name osmplotr
@@ -77,36 +77,36 @@ NULL
 #'
 #' A list of \code{SpatialPolygonsDataFrames} (SPDF),
 #' \code{SpatialLinesDataFrames} (SLDF), and \code{SpatialPointsDataFrames}
-#' (SPtDf) containing OpenStreetMap polygons and lines for various OpenStreetMap
-#' structures in a small part of central London,
+#' (SPtDf) objects containing OpenStreetMap polygons and lines for various
+#' OpenStreetMap structures in a small part of central London,
 #' U.K.  (\code{bbox = -0.15, 51.5, -0.1, 51.52}). The list includes:
 #' \enumerate{
-#'  \item \code{dat_H} an SLDF of non-primary highways with 1.764 lines 
-#'  \item \code{dat_HP} an SLDF of primary highways with 378 lines 
-#'  \item \code{dat_BNR} an SPDF of non-residential buildings with 2,138 polygons 
-#'  \item \code{dat_BR} an SPDF of residential buildings with 40 polygons 
-#'  \item \code{dat_BC} an SPDF of commerical buildings with 17 polygons 
-#'  \item \code{dat_A} an SPDF of amenities with 442 polygons 
-#'  \item \code{dat_G} an SPDF of grassed areas with 23 polygons 
-#'  \item \code{dat_P} an SPDF of parks with 24 polygons 
-#'  \item \code{dat_N} an SPDF of natural areas with 18 polygons 
-#'  \item \code{dat_T} an SPtDF of trees with 1,310 points 
-#'  \item \code{dat_RFH} an SPDF containing 1 polygon representing Royal
+#'  \item \code{dat_H}: an SLDF of non-primary highways with 1.764 lines 
+#'  \item \code{dat_HP}: an SLDF of primary highways with 378 lines 
+#'  \item \code{dat_BNR}: an SPDF of non-residential buildings with 2,138 polygons 
+#'  \item \code{dat_BR}: an SPDF of residential buildings with 40 polygons 
+#'  \item \code{dat_BC}: an SPDF of commerical buildings with 17 polygons 
+#'  \item \code{dat_A}: an SPDF of amenities with 442 polygons 
+#'  \item \code{dat_G}: an SPDF of grassed areas with 23 polygons 
+#'  \item \code{dat_P}: an SPDF of parks with 24 polygons 
+#'  \item \code{dat_N}: an SPDF of natural areas with 18 polygons 
+#'  \item \code{dat_T}: an SPtDF of trees with 1,310 points 
+#'  \item \code{dat_RFH}: an SPDF containing 1 polygon representing Royal
 #'      Festival Hall 
-#'  \item \code{dat_ST} an SPDF containing 1 polygon representing
+#'  \item \code{dat_ST}: an SPDF containing 1 polygon representing
 #'      150 Stamford Street
-#'  \item \code{highways1} A \code{SpatialPoints} object containing 55 points representing
-#'      the circular perimeter of \code{c ('Monmouth.St', 'Short.?s.Gardens', 
-#'      'Endell.St', 'Long.Acre', 'Upper.Saint.Martin')}
-#'  \item \code{highways2} A \code{SpatialPoints} object containing 47 points
+#'  \item \code{highways1}: A \code{SpatialPoints} object containing 55 points
+#'      representing the circular perimeter of \code{c ('Monmouth.St',
+#'      'Short.?s.Gardens', 'Endell.St', 'Long.Acre', 'Upper.Saint.Martin')}
+#'  \item \code{highways2}: A \code{SpatialPoints} object containing 47 points
 #'      representing the circular perimeter of 
 #'      \code{c ('Endell.St', 'High.Holborn', 'Drury.Lane', 'Long.Acre')}
-#'  \item \code{highways3} A \code{SpatialPoints} object containing 55 points
+#'  \item \code{highways3}: A \code{SpatialPoints} object containing 55 points
 #'      representing the circular perimeter of 
 #'      \code{c ('Drury.Lane', 'High.Holborn', 'Kingsway', 'Great.Queen.St')}
 #' }
 #'
-#' The vignette 'basic-maps' demonstrates how these data were downloaded.
+#' The vignette \code{basic-maps} details how these data were downloaded.
 #'
 #' @docType data
 #' @keywords datasets