In evelynsugi/weatherapi: Package to wrap the Weather API

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

weatherapi

The goal of weatherapi is to wrap the weather api accessible through weatherapi.com. This API enables us to get current and historical weather information, astronomical information, local time-zone information, and sports events information.

Available functions:

api_key(): to set the API key for the package
get_current_weather(): to get the current real-time weather information for a location or multiple locations (e.g. Kelowna, Vancouver)
get_time_zone(): to get the current time-zone information for a location or multiple locations (e.g. Kelowna, Vancouver)
get_sports_events(): to get the sports events information for a location or multiple locations (e.g. Kelowna, Vancouver)
get_astronomy(): to get up to date information for sunrise, sunset, moonrise, moonset, and moonphase
get_history_astro_information(): to get historical information for sunrise, sunset, moonrise, moonset, and moonphase
get_history_daily_weather(): to get historical daily weather information
get_history_hourly_weather(): to get historical hourly weather information

Installation

You can install the development version of weatherapi from GitHub with:

devtools::install_github("xintian927/534-project")

Setup

This package relies on the API key provided by the Weather API. To get started on using this package, please follow these steps:

Sign-up for an account here: https://www.weatherapi.com/signup.aspx
Go to your "my account" page and copy your API key
Open RStudio and set your API key in the .Renviron file
You can do this by running the following code in your R console
usethis::edit_r_environ()
Then add this line inside the .Renviron file
API_KEY = <your_api_key>
Save and close the .Renviron file and you are good to go!

Example

This is an example which shows you how to get the current weather information:

library(weatherapi)
get_current_weather("Kelowna")

You can also generate plots, for example:

library(ggplot2)
library(reshape2)

# Get current weather data
loc <- c("London", "New York", "Paris", "Melbourne", "Singapore") 
data <- get_current_weather(loc,"no")

# Get temperature info and melt dataframe
data <- data[c("location.name", "current.temp_c", "current.feelslike_c")]
data <- melt(data)

# Plot temperature
ggplot(data=data, aes(x=location.name, y=value, group=variable, linetype=variable)) +
  geom_line()+
  geom_point()+
  labs(title="Temperature by Location", subtitle="(in celcius)", x="", y="", linetype="")