{"Package":"TargomoR","Type":"Package","Title":"Interface to the 'Targomo' API","Version":"0.2.0","Authors@R":"person(\"Chris\", \"Mason-Thom\", email = \"chrismasonthom@gmail.com\", role=c(\"aut\",\"cre\"))","Description":"Functions to provide an intuitive interface for retrieving travel time data from the\n'Targomo' API (see for details). Provides support for retrieving\nisochrone polygons, travel routes, times and distances. Also includes functions for easily adding\nthe data to 'leaflet' maps, and functions for using the 'Targomo' map tiles.","License":"GPL-3","URL":"https://cwthom.github.io/TargomoR","BugReports":"https://github.com/cwthom/TargomoR/issues","Imports":"leaflet, magrittr, httr, jsonlite, geojsonsf, sf, tibble, xml2","Encoding":"UTF-8","LazyData":"true","RoxygenNote":"6.1.1","Suggests":"testthat (>= 2.1.0), covr, knitr, rmarkdown","NeedsCompilation":"no","Packaged":"2019-12-02 21:21:35 UTC; chris","Author":"Chris Mason-Thom [aut, cre]","Maintainer":"Chris Mason-Thom ","Repository":"CRAN","Date/Publication":"2019-12-06 23:40:08 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/TargomoR_0.2.0.tar.gz","jsonAuthors":[{"name":"Chris Mason-Thom","email":"chrismasonthom@gmail.com","maintainer":true}],"readme":"\n\n\n# TargomoR

\n\n\n\n[![CRAN\nstatus](https://r-pkg.org/badges/version/TargomoR)](https://CRAN.R-project.org/package=TargomoR)\n[![Travis-CI Build\nStatus](https://travis-ci.org/cwthom/TargomoR.svg?branch=master)](https://travis-ci.org/cwthom/TargomoR)\n[![codecov](https://codecov.io/gh/cwthom/TargomoR/branch/master/graph/badge.svg)](https://codecov.io/gh/cwthom/TargomoR)\n\n\n## Overview\n\nThe `TargomoR` package provides an R interface to the [Targomo REST\nAPI](https://targomo.com/developers/). Use `TargomoR` to get real\ntravel-time information:\n\n**Isochrone Polygons**: visualise what ‘half an hour away’ really looks\nlike, using public transport, driving, cycling or walking.\n\n**Travel Routes**: visualise up-to-date routing data quickly and simply,\nwith pre-written methods for adding complex data to leaflet maps.\n\n**Point-to-Point Times**: get travel-time data for a large array of\nsource and target points, in a tidy format ready to feed into further\nanalysis.\n\n## Note\n\n**This package is being developed with the permission of Targomo, but is\nnot an official product. For more information about Targomo, please see\ntheir [website](https://www.targomo.com/developers/), and be aware of\ntheir [terms and conditions](https://account.targomo.com/legal/terms).**\n\nSee below for information on [installing](#installation) the package,\nsetting up your [environment](#set-up-environment) correctly, and\n[using](#get-travel-time-data) the package.\n\n## Installation\n\nTargomoR is not yet on CRAN. To install this development version from\nGitHub please use:\n\n``` r\nremotes::install_github(\"cwthom/TargomoR\")\nlibrary(TargomoR)\n```\n\n## Set Up Environment\n\nThe functions in TargomoR all rely on having a Targomo API Key. To get\nyours, please [sign up with\nTargomo](https://targomo.com/developers/pricing/).\n\nYou’ll also need to know what region of the world to use. For example if\nyou’re looking for travel-time information in Germany, your region is\n“westcentraleurope”. [Find your\nregion](https://targomo.com/developers/resources/availability/). In the\nexamples on this page the region is “britishisles”.\n\nYou can pass these variables to each function manually if you like, but\nto avoid this, the functions will default to use the `TARGOMO_API_KEY`\nand `TARGOMO_REGION` environment variables respectively.\n\nTo take advantage of this, you can set these variables in an .Renviron\nfile. Use the following snippet to write the variables to the file.\n\n``` r\nsetTargomoVariables(api_key = \"\", region = \"\",\n global = FALSE)\n\n# global = TRUE will write to .Renviron at Sys.getenv(\"HOME\")\n# global = FALSE will write to .Renviron at getwd()\n```\n\nRestart R for these variables to take effect.\n\n## Get Travel Time Data\n\nYou’re now ready to use Targomo to get travel-time and routing data.\nThere are three services currently supported:\n\n - [Isochrone\n Polygons](https://targomo.com/developers/intro/services/polygon/)\n - [Routing](https://targomo.com/developers/intro/services/routing/)\n - [Time](https://targomo.com/developers/intro/services/reachability/)\n\nFor each service there are 3 core functions:\n\n - `getTargomo{service}` - returns an `sf` object containing the\n requested data.\n - `drawTargomo{service}` - draws the resultant object on a `leaflet`\n map.\n - `addTargomo{service}` - combines `get`-ting and `draw`-ing into a\n single call.\n\nThe `draw*` and `add*` functions are provided as a convenience - feel\nfree to create your own drawing functions to put the data onto a map\\!\n\nThere is also support for adding basemaps through `addTargomoTiles()`.\nSee the vignette on\n[basemaps](https://cwthom.github.io/TargomoR/articles/Basemaps.html) for\nmore information.\n\nYou can also check the capabilities of your Targomo account with\n`getTargomoCapabilities()`.\n\n## Attribution\n\nIt’s a condition of use of the Targomo services that you attribute the\ntravel time data to them. Full details can be found on their\n[attributions\npage](https://targomo.com/developers/resources/attribution/). To help\nwith this there are two functions in `TargomoR`:\n\n - `attributionLink` - just returns the URL of the attributions page\n - `addTargomoAttribution` - adds the attribution iframe to a leaflet\n control, for use with leaflet maps.\n\nIt is your responsibility to make sure you comply with the attribution\nrequirements appropriate to your plan.\n\n## Contributing\n\nPlease note that the ‘TargomoR’ project is released with a [Contributor\nCode of\nConduct](https://cwthom.github.io/TargomoR/CODE_OF_CONDUCT.html). By\ncontributing to this project, you agree to abide by its terms.\n\n-----\n\n### Logo\n\n - made using [hexsticker](https://github.com/GuangchuangYu/hexSticker)\n by GuangchuangYu.\n - icon: made by [Freepik](https://www.flaticon.com/authors/freepik)\n from [www.flaticon.com](https://www.flaticon.com/).\n - font: [Caveat](https://fonts.google.com/specimen/Caveat) from Google\n Fonts.","jobInfo":{"package":"TargomoR","version":"0.2.0","parsingStatus":"success","parserVersion":1,"parsedAt":"2019-12-07T01:30:25+0000"}}

Description

Usage

Arguments