otp_evaluate_surface: Evaluates an existing travel time surface (OTPv1 only).

Description Usage Arguments Details Value Examples

View source: R/otp_evaluate_surface.R

Description

Evaluates an existing travel time surface. Using a pointset from a specified CSV file, the travel time to each point is obtained from the specified surface. Accessibility indicators are then generated for one or more 'opportunity' columns in the pointset. For example, you might have the number of jobs available at each location, or the number of hospital beds.

Usage

1
otp_evaluate_surface(otpcon, surfaceId, pointset, detail = FALSE)

Arguments

otpcon

An OTP connection object produced by otp_connect.

surfaceId

Integer, the id number of an existing surface created using otp_create_surface().

pointset

Character string, the name of a pointset known to OTP. A pointset is contained in a CSV file present in the pointset directory location passed to OTP at startup. The name of the pointset is the name of the file (without extension).

detail

logical, whether the travel time from the surface origin to each location in the pointset should be returned. Default is FALSE.

Details

This function requires OTP to have been started with the --analyst switch and the --pointset parameter set to the path of a directory containing the pointset file(s).

Value

Assuming no error, returns a list containing 4 or more elements:

If there is an error, a list containing 3 elements is returned:

Examples

1
2
3
4
## Not run: 
otp_evaluate_surface(otpcon, surfaceId = 0, pointset = "jobs", detail = TRUE)

## End(Not run)

otpr documentation built on Jan. 7, 2022, 5:26 p.m.