-
Notifications
You must be signed in to change notification settings - Fork 20
/
README.Rmd
113 lines (74 loc) · 5.6 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# OpenTripPlanner for R <a href='https://itsleeds.github.io/'><img src='man/figures/logo.png' align="right" height=180/></a>
[](https://github.com/ropensci/opentripplanner/actions)
[](https://app.codecov.io/gh/ropensci/opentripplanner)
[](https://www.repostatus.org/#active)
[](https://github.com/ropensci/software-review/issues/295)
[](https://doi.org/10.5281/zenodo.3558311)
[](https://joss.theoj.org/papers/10.21105/joss.01926)
[](https://cran.r-project.org/package=opentripplanner)
[](https://cran.r-project.org/package=opentripplanner)
**opentripplanner** is an R package that provides a simple yet flexible interface to [OpenTripPlanner (OTP)](https://www.opentripplanner.org/). OTP is a multimodal trip planning service written in Java. For more information on what OTP is, see the [prerequisites vignette](https://docs.ropensci.org/opentripplanner/articles/prerequisites.html).
**opentripplanner** can be used to interface with a remote instance of OTP (e.g. a website) or help you set up and manage a local version of OTP for private use. Basic setup and routing functions are outlined in the [getting started vignette](https://docs.ropensci.org/opentripplanner/articles/opentripplanner.html), while advanced functionality such as batch routing, isochrones, and customised setup is described in the [advanced features vignette](https://docs.ropensci.org/opentripplanner/articles/advanced_features.html).
## What's New
The newest version of the package 0.5.0 (Jan 2023) focuses on increased routing speeds (3-4x faster) and expanding support for OTP v2.2. The new version also drops legacy support for R 3.6, and so now requires R 4.0 or later. See [news](https://docs.ropensci.org/opentripplanner/news/index.html) for more details.
## Installation
### OpenTripPlanner
To use OpenTripPlanner on your local computer you will need to install Java 8 and download the latest version of OTP. Instructions on installing Java and setting up OTP can be found in the [prerequisites vignette](https://docs.ropensci.org/opentripplanner/articles/prerequisites.html).
### R Package
To install the stable CRAN version:
```{r installCRAN, eval=FALSE}
install.packages("opentripplanner") # Install Package
library(opentripplanner) # Load Package
```
Install the development version using **remotes**:
```{r install, eval=FALSE}
# If you do not already have the remotes package
install.packages("remotes")
# Install the package from GitHub
remotes::install_github("ropensci/opentripplanner")
# Load the package
library(opentripplanner)
```
## Usage
The package contains three groups of functions:
Functions for setting up a local instance of OTP:
1. `otp_dl_jar()` To download the OTP Jar file;
1. `otp_dl_demo()` To download the demo data for the Isle of Wight;
1. `otp_check_java()` To check you have the correct version of Java;
1. `otp_build_graph()` To make a OTP graph from raw data;
1. `otp_setup()` To start up a local instance of OTP;
1. `otp_make_config()` To make a config object;
1. `otp_validate_config()` To validate a config object;
1. `otp_write_config()` To save a config object as a json file.
Functions for connecting to a local or remote instance of OTP:
1. `otp_connect()` To connect to OTP.
Functions for retrieving data from OTP:
1. `otp_plan()` To get routes from A to B;
1. `otp_geocode()` To get the locations of named places e.g. road names (OTP 1.x only);
1. `otp_isochrone()` To get isochrone maps (OTP 1.x only);
1. `otp_make_surface()` To make an analyst surface (OTP 1.x only);
1. `otp_surface()` To evaluate a analyst surface (OTP 1.x only);
1. `otp_traveltime()` To make a travel time matrix (OTP 1.x only);
1. `otp_surface_isochrone()` To make a raster isochrone map (OTP 1.x only);
Results are returned as [sf objects](https://CRAN.R-project.org/package=sf).
## Acknowledgement
This package was built off the [tutorial by Marcus Young](https://github.com/marcusyoung/otp-tutorial).
## Contribution
Please note that the `opentripplanner` project is released with a [Contributor Code of Conduct](https://github.com/ropensci/opentripplanner/blob/master/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms. Bug reports and comments are welcome as Github [Issues](https://github.com/ropensci/opentripplanner/issues) and code submissions as [Pull Requests](https://github.com/ropensci/opentripplanner/pulls).
## Citation
Please cite the JOSS paper in publications:
Morgan et al., (2019). OpenTripPlanner for R. Journal of Open Source Software,
4(44), 1926, https://doi.org/10.21105/joss.01926
[](https://ropensci.org)