From 14b671f1c2e09e45459203f72389667a9e59ba53 Mon Sep 17 00:00:00 2001 From: Michael Hodge Date: Fri, 18 Jan 2019 16:56:43 +0000 Subject: [PATCH] document update for build --- propeR/R/data.R | 1 - propeR/R/isochrone-multi-intersect.R | 1 - propeR/R/isochrone-multi.R | 1 - propeR/R/isochrone-time.R | 1 - propeR/R/isochrone.R | 1 - propeR/R/point-to-point-loop.R | 1 - propeR/R/point-to-point-time.R | 1 - propeR/R/point-to-point.R | 1 - propeR/man/importGeojsonData.Rd | 6 ++--- propeR/man/importLocationData.Rd | 20 +++++++++----- propeR/man/isochrone.Rd | 27 +++++++++---------- propeR/man/isochroneMulti.Rd | 20 +++++++------- propeR/man/isochroneTime.Rd | 20 +++++++------- propeR/man/pointToPoint.Rd | 26 +++++++++--------- propeR/man/pointToPointLoop.Rd | 18 ++++++++----- propeR/man/pointToPointTime.Rd | 20 +++++++------- propeR/man/postcodeToDecimalDegrees_backup.Rd | 2 +- 17 files changed, 85 insertions(+), 82 deletions(-) diff --git a/propeR/R/data.R b/propeR/R/data.R index e7f60f6..855b0b2 100644 --- a/propeR/R/data.R +++ b/propeR/R/data.R @@ -7,7 +7,6 @@ ##' @param loncol The title of the header of the column containing the longitudinal values, default is "lon" ##' @param latcol The title of the header of the column containing the latitudinal values, default is "lat" ##' @param postcodecol The title of the header of the column containing the postcode values, default is "postcode" -##' @param ##' @return R dataframe of location points ##' @author Michael Hodge ##' @examples originPoints <- importLocationData('C:\Users\User\Documents\origins.csv', idcol = "name", loncol = "lon", latcol = "lat") diff --git a/propeR/R/isochrone-multi-intersect.R b/propeR/R/isochrone-multi-intersect.R index 11a39f5..627c251 100644 --- a/propeR/R/isochrone-multi-intersect.R +++ b/propeR/R/isochrone-multi-intersect.R @@ -28,7 +28,6 @@ ##' @param mapPolygonFillOpacity Specifies the opacity of the polygon fill, defaults to 0.6 ##' @param mapMarkerOpacity Specifies the opacity of the marker, defaults to 1 (solid) ##' @param mapLegendOpacity Specifies the opacity of the legend, defaults to 0.5 -##' @param ##' @return Saves map as a Geojson of the intersection area to output directory (optional: a map in PNG and HTML formats) ##' @author Michael Hodge ##' @examples diff --git a/propeR/R/isochrone-multi.R b/propeR/R/isochrone-multi.R index 175941c..3217fe2 100755 --- a/propeR/R/isochrone-multi.R +++ b/propeR/R/isochrone-multi.R @@ -31,7 +31,6 @@ ##' @param mapPolygonFillOpacity Specifies the opacity of the polygon fill, defaults to 0.6 ##' @param mapMarkerOpacity Specifies the opacity of the marker, defaults to 1 (solid) ##' @param mapLegendOpacity Specifies the opacity of the legend, defaults to 0.5 -##' @param ##' @return Saves journey details as CSV to output directory (optional: a map in PNG and HTML formats, the polygons as a GeoJSON) ##' @author Michael Hodge ##' @examples diff --git a/propeR/R/isochrone-time.R b/propeR/R/isochrone-time.R index 3f42261..44d8f5b 100755 --- a/propeR/R/isochrone-time.R +++ b/propeR/R/isochrone-time.R @@ -34,7 +34,6 @@ ##' @param mapPolygonFillOpacity Specifies the opacity of the polygon fill, defaults to 0.6 ##' @param mapMarkerOpacity Specifies the opacity of the marker, defaults to 1 (solid) ##' @param mapLegendOpacity Specifies the opacity of the legend, defaults to 0.5 -##' @param ##' @return Saves journey details as comma separated value file to output directory. An animated map in .gif format may also be saved. ##' @author Michael Hodge ##' @examples diff --git a/propeR/R/isochrone.R b/propeR/R/isochrone.R index 6df00a6..505e50a 100755 --- a/propeR/R/isochrone.R +++ b/propeR/R/isochrone.R @@ -31,7 +31,6 @@ ##' @param mapPolygonFillOpacity Specifies the opacity of the polygon fill, defaults to 0.6 ##' @param mapMarkerOpacity Specifies the opacity of the marker, defaults to 1 (solid) ##' @param mapLegendOpacity Specifies the opacity of the legend, defaults to 0.5 -##' @param ##' @return Saves journey details as comma separated value file to output directory. A map in .png and .html formats, and/or a polygon as a .GeoJSON format, may also be saved) ##' @author Michael Hodge ##' @examples diff --git a/propeR/R/point-to-point-loop.R b/propeR/R/point-to-point-loop.R index b0553d7..066a98b 100755 --- a/propeR/R/point-to-point-loop.R +++ b/propeR/R/point-to-point-loop.R @@ -22,7 +22,6 @@ ##' @param wheelchair If TRUE, uses on wheeelchair friendly stops, defaults to FALSE ##' @param arriveBy Selects whether journey starts at startDateandTime (FALSE) or finishes (TRUE), defaults to FALSE ##' @param preWaitTime The maximum waiting time before a journey cannot be found, in minutes, defaults to 15 mins -##' @param ##' @return Saves journey details as comma separated value file to output directory ##' @author Michael Hodge ##' @examples diff --git a/propeR/R/point-to-point-time.R b/propeR/R/point-to-point-time.R index 35cc20b..5e0cb0a 100755 --- a/propeR/R/point-to-point-time.R +++ b/propeR/R/point-to-point-time.R @@ -31,7 +31,6 @@ ##' @param mapPolylineOpacity Specifies the opacity of the polyline, defaults to 1 (solid) ##' @param mapMarkerOpacity Specifies the opacity of the marker, defaults to 1 (solid) ##' @param mapLegendOpacity Specifies the opacity of the legend, defaults to 1 (solid) -##' @param ##' @return Saves journey details as comma separated value file to output directory. An animated map in .gif format may also be saved. ##' @author Michael Hodge ##' @examples diff --git a/propeR/R/point-to-point.R b/propeR/R/point-to-point.R index e6921e0..18e4c3b 100755 --- a/propeR/R/point-to-point.R +++ b/propeR/R/point-to-point.R @@ -28,7 +28,6 @@ ##' @param mapPolylineOpacity Specifies the opacity of the polyline, defaults to 1 (solid) ##' @param mapMarkerOpacity Specifies the opacity of the marker, defaults to 1 (solid) ##' @param mapLegendOpacity Specifies the opacity of the legend, defaults to 1 (solid) -##' @param ##' @return Saves journey details as comma separated value file to output directory. A map in .png and .html formats may also be saved) ##' @author Michael Hodge ##' @examples diff --git a/propeR/man/importGeojsonData.Rd b/propeR/man/importGeojsonData.Rd index d9f8afe..3a36eea 100644 --- a/propeR/man/importGeojsonData.Rd +++ b/propeR/man/importGeojsonData.Rd @@ -2,18 +2,18 @@ % Please edit documentation in R/data.R \name{importGeojsonData} \alias{importGeojsonData} -\title{Imports Geojson Data} +\title{Imports GeoJSON Data} \usage{ importGeojsonData(src) } \arguments{ -\item{src}{.Geojson file source} +\item{src}{The source for the .GeoJSON file} } \value{ Large SpatialPolygonsDataFrame of origin polygons } \description{ -Imports polygon data (origin) from a geojson file +Imports polygon data from a GeoJSON file } \examples{ originPolygons <- importGeojsonData('C:\\Users\\User\\Documents\\origins.geojson') diff --git a/propeR/man/importLocationData.Rd b/propeR/man/importLocationData.Rd index fafb8d1..325055d 100644 --- a/propeR/man/importLocationData.Rd +++ b/propeR/man/importLocationData.Rd @@ -4,20 +4,28 @@ \alias{importLocationData} \title{Imports Location Data} \usage{ -importLocationData(src) +importLocationData(src, idcol = "name", loncol = "lon", + latcol = "lat", postcodecol = "postcode") } \arguments{ -\item{src}{.CSV file source} +\item{src}{The source of the .CSV file} + +\item{idcol}{The title of the header of the column containing unique identifier names, default is "name"} + +\item{loncol}{The title of the header of the column containing the longitudinal values, default is "lon"} + +\item{latcol}{The title of the header of the column containing the latitudinal values, default is "lat"} + +\item{postcodecol}{The title of the header of the column containing the postcode values, default is "postcode"} } \value{ -R dataframe of origin or destination points +R dataframe of location points } \description{ -Imports location data (origin or destination) from a comma separated file +Imports location data from a comma separated file containing either latitude and longitude values, or postcode values } \examples{ -originPoints <- importLocationData('C:\\Users\\User\\Documents\\origins.csv') -destinationPoints <- importLocationData('C:\\Users\\User\\Documents\\destinations.csv') +originPoints <- importLocationData('C:\\Users\\User\\Documents\\origins.csv', idcol = "name", loncol = "lon", latcol = "lat") } \author{ Michael Hodge diff --git a/propeR/man/isochrone.Rd b/propeR/man/isochrone.Rd index 1f44397..1e03d3f 100644 --- a/propeR/man/isochrone.Rd +++ b/propeR/man/isochrone.Rd @@ -10,22 +10,21 @@ isochrone(output.dir, otpcon, originPoints, originPointsRow = 1, maxWalkDistance = 1000, walkReluctance = 2, walkSpeed = 1.5, bikeSpeed = 5, minTransferTime = 1, maxTransfers = 5, wheelchair = F, arriveBy = F, isochroneCutOffs = c(30, 60, 90), - mapOutput = FALSE, geojsonOutput = FALSE, - mapPolygonColours = "Blues", mapZoom = 12, - mapPolygonLineWeight = 5, mapPolygonLineOpacity = 1, - mapPolygonFillOpacity = 0.6, mapMarkerOpacity = 1, - mapLegendOpacity = 0.5) + mapOutput = F, geojsonOutput = F, mapPolygonColours = "Blues", + mapZoom = "bb", mapPolygonLineWeight = 5, + mapPolygonLineOpacity = 1, mapPolygonFillOpacity = 0.6, + mapMarkerOpacity = 1, mapLegendOpacity = 0.5) } \arguments{ \item{output.dir}{The directory for the output files} -\item{otpcon}{The OTP router URL} +\item{otpcon}{The OTP router URL, see ?otpcon for details} -\item{originPoints}{The variable containing origin(s), see ?importLocationData} +\item{originPoints}{The variable containing origin(s), see ?importLocationData for details} \item{originPointsRow}{The row of originPoints to be used, defaults to 1} -\item{destinationPoints}{The variable containing destination(s) see ?importLocationData} +\item{destinationPoints}{The variable containing destination(s) see ?importLocationData for details} \item{startDateAndTime}{The start time and date, in 'YYYY-MM-DD HH:MM:SS' format} @@ -55,7 +54,7 @@ isochrone(output.dir, otpcon, originPoints, originPointsRow = 1, \item{mapPolygonColours}{The color palette of the map, defaults to 'Blues'} -\item{mapZoom}{The zoom level of the map, defaults to 12} +\item{mapZoom}{The zoom level of the map as an integer (e.g. 12), defaults to bounding box approach} \item{mapPolygonLineWeight}{Specifies the weight of the polygon, defaults to 5 px} @@ -68,14 +67,14 @@ isochrone(output.dir, otpcon, originPoints, originPointsRow = 1, \item{mapLegendOpacity}{Specifies the opacity of the legend, defaults to 0.5} } \value{ -Saves journey details as CSV to output directory (optional: a map in PNG and HTML formats, the polygon as a GeoJSON) +Saves journey details as comma separated value file to output directory. A map in .png and .html formats, and/or a polygon as a .GeoJSON format, may also be saved) } \description{ -Generates an isochrone map from a single origin and checks whether destinations +Generates an isochrone polygon from a single origin and checks whether destinations fall within isochrone, and if so, at what cutoff time amount. -A CSV file of journey details is saved in the output folder. -A map of the journey can also be saved as a PNG image and HTML file. -The polygon can also be saved as a GeoJSON file. +A comma separated value file of journey times for each destination is saved in the output folder. +A map of the journey can also be saved as a .png image and .html file. +The polygon can also be saved as a .GeoJSON file. } \examples{ isochrone( diff --git a/propeR/man/isochroneMulti.Rd b/propeR/man/isochroneMulti.Rd index da5ee0e..11fc504 100644 --- a/propeR/man/isochroneMulti.Rd +++ b/propeR/man/isochroneMulti.Rd @@ -5,12 +5,12 @@ \title{Generates an isochrone map for multiple origins.} \usage{ isochroneMulti(output.dir, otpcon, originPoints, destinationPoints, - journeyReturn = FALSE, startDateAndTime = "2018-08-18 12:00:00", + journeyReturn = F, startDateAndTime = "2018-08-18 12:00:00", modes = "WALK, TRANSIT", maxWalkDistance = 1000, walkReluctance = 2, walkSpeed = 1.5, bikeSpeed = 5, minTransferTime = 1, maxTransfers = 5, wheelchair = F, - arriveBy = F, isochroneCutOffs = c(30, 60, 90), mapOutput = FALSE, - geojsonOutput = FALSE, mapPolygonColours = "Blues", mapZoom = 12, + arriveBy = F, isochroneCutOffs = c(30, 60, 90), mapOutput = F, + geojsonOutput = F, mapPolygonColours = "Blues", mapZoom = "bb", mapPolygonLineWeight = 5, mapPolygonLineOpacity = 1, mapPolygonFillOpacity = 0.6, mapMarkerOpacity = 1, mapLegendOpacity = 0.5) @@ -18,11 +18,11 @@ isochroneMulti(output.dir, otpcon, originPoints, destinationPoints, \arguments{ \item{output.dir}{The directory for the output files} -\item{otpcon}{The OTP router URL} +\item{otpcon}{The OTP router URL, see ?otpcon for details} -\item{originPoints}{The variable containing origin(s), see ?importLocationData} +\item{originPoints}{The variable containing origin(s), see ?importLocationData for details} -\item{destinationPoints}{The variable containing destination(s) see ?importLocationData} +\item{destinationPoints}{The variable containing destination(s) see ?importLocationData for details} \item{journeyReturn}{Specifies whether the journey should be calculated as a return or not (default is FALSE)} @@ -54,7 +54,7 @@ isochroneMulti(output.dir, otpcon, originPoints, destinationPoints, \item{mapPolygonColours}{The color palette of the map, defaults to 'Blues'} -\item{mapZoom}{The zoom level of the map, defaults to 12} +\item{mapZoom}{The zoom level of the map as an integer (e.g. 12), defaults to bounding box approach} \item{mapPolygonLineWeight}{Specifies the weight of the polygon, defaults to 5 px} @@ -72,9 +72,9 @@ Saves journey details as CSV to output directory (optional: a map in PNG and HTM \description{ Generates an isochrone map from multiple origins and checks whether destinations fall within isochrones, and if so, at what cutoff time amount. -A CSV file of journey details is saved in the output folder. -A map of the journey can also be saved as a PNG image and HTML file. -The polygons can also be saved as a GeoJSON file. +A comma separated value file of journey times for each origin and destination is saved in the output folder. +A map of the journey can also be saved as a .png image and .html file. +The polygons can also be saved as a .GeoJSON file. } \examples{ isochroneMulti( diff --git a/propeR/man/isochroneTime.Rd b/propeR/man/isochroneTime.Rd index a5e9fc0..ab4f751 100644 --- a/propeR/man/isochroneTime.Rd +++ b/propeR/man/isochroneTime.Rd @@ -12,8 +12,8 @@ isochroneTime(output.dir, otpcon, originPoints, originPointsRow = 1, modes = "WALK, TRANSIT", maxWalkDistance = 1000, walkReluctance = 2, walkSpeed = 1.5, bikeSpeed = 5, minTransferTime = 1, maxTransfers = 5, wheelchair = F, - arriveBy = F, isochroneCutOffs = c(30, 60, 90), mapOutput = FALSE, - mapPolygonColours = "Blues", mapZoom = 12, + arriveBy = F, isochroneCutOffs = c(30, 60, 90), mapOutput = F, + mapPolygonColours = "Blues", mapZoom = "bb", mapPolygonLineWeight = 5, mapPolygonLineOpacity = 1, mapPolygonFillOpacity = 0.6, mapMarkerOpacity = 1, mapLegendOpacity = 0.5) @@ -21,13 +21,13 @@ isochroneTime(output.dir, otpcon, originPoints, originPointsRow = 1, \arguments{ \item{output.dir}{The directory for the output files} -\item{otpcon}{The OTP router URL} +\item{otpcon}{The OTP router URL, see ?otpcon for details} -\item{originPoints}{The variable containing origin(s), see ?importLocationData} +\item{originPoints}{The variable containing origin(s), see ?importLocationData for details} \item{originPointsRow}{The row of originPoints to be used, defaults to 1} -\item{destinationPoints}{The variable containing destination(s) see ?importLocationData} +\item{destinationPoints}{The variable containing destination(s) see ?importLocationData for details} \item{startDateAndTime}{The start time and date, in 'YYYY-MM-DD HH:MM:SS' format} @@ -59,7 +59,7 @@ isochroneTime(output.dir, otpcon, originPoints, originPointsRow = 1, \item{mapPolygonColours}{The color palette of the map, defaults to 'Blues'} -\item{mapZoom}{The zoom level of the map, defaults to 12} +\item{mapZoom}{The zoom level of the map as an integer (e.g. 12), defaults to bounding box approach} \item{mapPolygonLineWeight}{Specifies the weight of the polygon, defaults to 5 px} @@ -74,14 +74,14 @@ isochroneTime(output.dir, otpcon, originPoints, originPointsRow = 1, \item{geojsonOutput}{Specifies whether you want to output a GeoJSON file, defaults to FALSE} } \value{ -Saves journey details as CSV to output directory (optional: an animated map in GIF format) +Saves journey details as comma separated value file to output directory. An animated map in .gif format may also be saved. } \description{ -Generates an isochrone map from a single origin between a start and end +Generates isochrone polygons from a single origin between a start and end time and date, and checks whether destinations fall within isochrone, and if so, at what cutoff time amount. -A CSV file of journey details is saved in the output folder. -A map of the journey can also be saved as a PNG image and HTML file. +A comma separated value file of journey times for each destination (and time) is saved in the output folder. +An animated map of the journey can also be saved as a .gif image. } \examples{ isochroneTime( diff --git a/propeR/man/pointToPoint.Rd b/propeR/man/pointToPoint.Rd index 3260a88..87bbcb8 100644 --- a/propeR/man/pointToPoint.Rd +++ b/propeR/man/pointToPoint.Rd @@ -9,22 +9,22 @@ pointToPoint(output.dir, otpcon, originPoints, originPointsRow = 1, startDateAndTime = "2018-08-18 12:00:00", modes = "WALK, TRANSIT", maxWalkDistance = 1000, walkReluctance = 2, walkSpeed = 1.4, bikeSpeed = 4.3, minTransferTime = 1, maxTransfers = 10, - wheelchair = F, arriveBy = F, preWaitTime = 60, - mapOutput = FALSE, mapPolylineColours = list(TRANSIT = "#000000", - WALK = "#A14296", BUS = "#48C1B1", RAIL = "#4D7BC5", CAR = "#E825D6", - BICYCLE = "#4AA6C3"), mapZoom = 12, mapPolylineWeight = 5, - mapPolylineOpacity = 1, mapMarkerOpacity = 1, mapLegendOpacity = 1) + wheelchair = F, arriveBy = F, preWaitTime = 15, mapOutput = F, + mapPolylineColours = list(TRANSIT = "#000000", WALK = "#A14296", BUS = + "#48C1B1", RAIL = "#4D7BC5", CAR = "#E825D6", BICYCLE = "#4AA6C3"), + mapZoom = "bb", mapPolylineWeight = 5, mapPolylineOpacity = 1, + mapMarkerOpacity = 1, mapLegendOpacity = 1) } \arguments{ \item{output.dir}{The directory for the output files} -\item{otpcon}{The OTP router URL} +\item{otpcon}{The OTP router URL, see ?otpcon for details} -\item{originPoints}{The variable containing origin(s), see ?importLocationData} +\item{originPoints}{The variable containing origin(s), see ?importLocationData for details} \item{originPointsRow}{The row of originPoints to be used, defaults to 1} -\item{destinationPoints}{The variable containing destination(s) see ?importLocationData} +\item{destinationPoints}{The variable containing destination(s) see ?importLocationData for details} \item{destinationPointsRow}{The row of destinationPoints to be used, defaults to 1} @@ -48,13 +48,13 @@ pointToPoint(output.dir, otpcon, originPoints, originPointsRow = 1, \item{arriveBy}{Selects whether journey starts at startDateandTime (FALSE) or finishes (TRUE), defaults to FALSE} -\item{preWaitTime}{The maximum waiting time before a journey cannot be found, in minutes, defaults to 60 mins} +\item{preWaitTime}{The maximum waiting time before a journey cannot be found, in minutes, defaults to 15 mins} \item{mapOutput}{Specifies whether you want to output a map, defaults to FALSE} \item{mapPolylineColours}{A list defining the colours to assign to each mode of transport.} -\item{mapZoom}{The zoom level of the map, defaults to 12} +\item{mapZoom}{The zoom level of the map as an integer (e.g. 12), defaults to bounding box approach} \item{mapPolylineWeight}{Specifies the weight of the polyline, defaults to 5 px} @@ -65,12 +65,12 @@ pointToPoint(output.dir, otpcon, originPoints, originPointsRow = 1, \item{mapLegendOpacity}{Specifies the opacity of the legend, defaults to 1 (solid)} } \value{ -Saves journey details as CSV to output directory (optional: a map in PNG and HTML formats) +Saves journey details as comma separated value file to output directory. A map in .png and .html formats may also be saved) } \description{ Calculates the journey time and details between a single origin and destination. -A CSV file of journey details is saved in the output folder. -A map of the journey can also be saved as a PNG image and HTML file. +A comma separated value file of journey details is saved in the specified output folder. +A map of the journey can also be saved as a .png image and .html file. } \examples{ pointToPoint( diff --git a/propeR/man/pointToPointLoop.Rd b/propeR/man/pointToPointLoop.Rd index b21f8f8..fdd8cc6 100644 --- a/propeR/man/pointToPointLoop.Rd +++ b/propeR/man/pointToPointLoop.Rd @@ -6,22 +6,22 @@ \usage{ pointToPointLoop(output.dir, otpcon, originPoints, originPointsRow = 1, destinationPoints, destinationPointsRow = 1, journeyLoop = 0, - journeyReturn = TRUE, startDateAndTime = "2018-08-13 09:00:00", + journeyReturn = T, startDateAndTime = "2018-08-13 09:00:00", modes = "WALK, TRANSIT", maxWalkDistance = 1000, walkReluctance = 2, walkSpeed = 1.5, bikeSpeed = 5, minTransferTime = 1, maxTransfers = 5, wheelchair = F, - arriveBy = F) + arriveBy = F, preWaitTime = 15) } \arguments{ \item{output.dir}{The directory for the output files} -\item{otpcon}{The OTP router URL} +\item{otpcon}{The OTP router URL, see ?otpcon for details} -\item{originPoints}{The variable containing origin(s), see ?importLocationData} +\item{originPoints}{The variable containing origin(s), see ?importLocationData for details} \item{originPointsRow}{The row of originPoints to be used, defaults to 1} -\item{destinationPoints}{The variable containing destination(s) see ?importLocationData} +\item{destinationPoints}{The variable containing destination(s) see ?importLocationData for details} \item{destinationPointsRow}{The row of destinationPoints to be used, defaults to 1} @@ -48,13 +48,15 @@ pointToPointLoop(output.dir, otpcon, originPoints, originPointsRow = 1, \item{wheelchair}{If TRUE, uses on wheeelchair friendly stops, defaults to FALSE} \item{arriveBy}{Selects whether journey starts at startDateandTime (FALSE) or finishes (TRUE), defaults to FALSE} + +\item{preWaitTime}{The maximum waiting time before a journey cannot be found, in minutes, defaults to 15 mins} } \value{ -Saves journey details as CSV to output directory +Saves journey details as comma separated value file to output directory } \description{ Calculates the journey time and details between multiple origins and/or destinations. -A CSV file of journey details is saved in the output folder. +A comma separated value file of journey details is saved in the output folder. } \examples{ pointToPointLoop( @@ -62,6 +64,8 @@ A CSV file of journey details is saved in the output folder. otpcon, originPoints, destinationPoints, + journeyLoop = 0, + journeyReturn = TRUE, startDateAndTime = "2018-08-18 12:00:00" ) } diff --git a/propeR/man/pointToPointTime.Rd b/propeR/man/pointToPointTime.Rd index 64f9d8b..02e6869 100644 --- a/propeR/man/pointToPointTime.Rd +++ b/propeR/man/pointToPointTime.Rd @@ -12,22 +12,22 @@ pointToPointTime(output.dir, otpcon, originPoints, originPointsRow = 1, modes = "WALK, TRANSIT", maxWalkDistance = 1000, walkReluctance = 2, walkSpeed = 1.5, bikeSpeed = 5, minTransferTime = 1, maxTransfers = 5, wheelchair = F, - arriveBy = F, preWaitTime = 60, mapOutput = FALSE, + arriveBy = F, preWaitTime = 15, mapOutput = F, mapPolylineColours = list(TRANSIT = "#000000", WALK = "#A14296", BUS = "#48C1B1", RAIL = "#4D7BC5", CAR = "#8D4084", BICYCLE = "#4AA6C3"), - mapZoom = 12, mapPolylineWeight = 5, mapPolylineOpacity = 1, + mapZoom = "bb", mapPolylineWeight = 5, mapPolylineOpacity = 1, mapMarkerOpacity = 1, mapLegendOpacity = 1) } \arguments{ \item{output.dir}{The directory for the output files} -\item{otpcon}{The OTP router URL} +\item{otpcon}{The OTP router URL, see ?otpcon for details} -\item{originPoints}{The variable containing origin(s), see ?importLocationData} +\item{originPoints}{The variable containing origin(s), see ?importLocationData for details} \item{originPointsRow}{The row of originPoints to be used, defaults to 1} -\item{destinationPoints}{The variable containing destination(s) see ?importLocationData} +\item{destinationPoints}{The variable containing destination(s) see ?importLocationData for details} \item{destinationPointsRow}{The row of destinationPoints to be used, defaults to 1} @@ -55,13 +55,13 @@ pointToPointTime(output.dir, otpcon, originPoints, originPointsRow = 1, \item{arriveBy}{Selects whether journey starts at startDateandTime (FALSE) or finishes (TRUE), defaults to FALSE} -\item{preWaitTime}{The maximum waiting time before a journey cannot be found, in minutes, defaults to 60 mins} +\item{preWaitTime}{The maximum waiting time before a journey cannot be found, in minutes, defaults to 15 mins} \item{mapOutput}{Specifies whether you want to output a map, defaults to FALSE} \item{mapPolylineColours}{A list defining the colours to assign to each mode of transport.} -\item{mapZoom}{The zoom level of the map, defaults to 12} +\item{mapZoom}{The zoom level of the map as an integer (e.g. 12), defaults to bounding box approach} \item{mapPolylineWeight}{Specifies the weight of the polyline, defaults to 5 px} @@ -72,12 +72,12 @@ pointToPointTime(output.dir, otpcon, originPoints, originPointsRow = 1, \item{mapLegendOpacity}{Specifies the opacity of the legend, defaults to 1 (solid)} } \value{ -Saves journey details as CSV to output directory (optional: an animated map in GIF format) +Saves journey details as comma separated value file to output directory. An animated map in .gif format may also be saved. } \description{ Calculates the journey time and details between a single origin and destination between a start -and end time and date. A CSV file of journey details is saved in the output folder. -An animated map of the journey can also be saved as a GIF file. +and end time and date. A comma separated value file of journey details is saved in the output folder. +An animated map of the journey can also be saved as a .gif image. } \examples{ pointToPointTime( diff --git a/propeR/man/postcodeToDecimalDegrees_backup.Rd b/propeR/man/postcodeToDecimalDegrees_backup.Rd index efd5af7..21489e7 100644 --- a/propeR/man/postcodeToDecimalDegrees_backup.Rd +++ b/propeR/man/postcodeToDecimalDegrees_backup.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/geo-util.R \name{postcodeToDecimalDegrees_backup} \alias{postcodeToDecimalDegrees_backup} -\title{A backup simple postcode to latitude and longitude converter.} +\title{A backup postcode to latitude and longitude converter.} \usage{ postcodeToDecimalDegrees_backup(postcode) }