knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

teleporrrt

The goal of teleporrrt is to construct detailed visuals and convey information from the Teleport API

Installation

You can install the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("DeclanMolony/teleporrrt")
library(teleporrrt)

Cities in the Teleport API

You can use the function city_lookup() to produce a dataframe of all the cities used in the Teleport API, and their html links.

#city_lookup()

You can use the function country_lookup() to produce a dataframe of all the countries used in the Teleport API, and their html links.

#country_lookup()

Or you can use cities_valid() to check whether a particular city is in the Teleport API

cities_valid(cities = "Constantinople")

Individual City Links

You can use the function city_link() to produce an html link for a particular city's scores to be used for your own analysis:

city_link("Dublin")

You can use the function area_link() to produce an html link for a particular countries or cities salaries to be used for your own analysis:

area_link("San Diego")
area_link("United States", "country")

Dataframes

You can create a dataframe of a single city's Teleport metrics:

city_dataframe("New York")

Or create a dataframe comparing two cities:

city_combine_df("Cairo","Zurich")

Or create a dataframe with the closest city to a given Longitude/Latitude coordinates

#Coordinates of the White House
nearest_city(lat = 38.8977, lon = -77.0365)

Or create a dataframe of the 25th, 50th, and 75th quantiles of salaries for a given city or country.

US_salary <- salaries_qt("United States", "country")

head(US_salary)

Spider Chart

You can even create a radar/spider chart comparing two cities' scores

city_radarchart("Hong Kong","Detroit")

City Ratings

You can input a list of cities you're interested in comparing based on cost of living, housing, or education, and find out which of the cities has the maximum rating and which has the minimum rating

MaxMinRating(c("Toronto", "Vancouver"), "Cost of Living")


DeclanMolony/teleporrrt documentation built on May 12, 2020, 1:02 a.m.