In hrbrmstr/mywx: Tools to Query the 'MetMalaysia' Web Service 'API'

mywx : Tools to Query the 'MetMalaysia' Web Service 'API'

The Malaysian Meteorological Web Service API (Application Programming Interface) is a free service offered by Malaysian Meteorological Department to the general public. The service, which serves on top of HTTP, exposes endpoints with JSON response, a human readable yet programmatically parseable data exchange format.

This package provides a small set of functions to retrive locations (as you need the id for a location to use it) and forecast info.

I don't live in Malaysia or use this service at all but it was an easy API to wrap. If you'd like to own this, please just say the word. It needs some work, especially since the "forecast" data returned had no real concept of proper tidy data in mind.

You need a valid token either passed in to mywx_api_token or stored in the MYWX_TOKEN environment variable, preferably in ~/.Renviron.

NOTE: Maximum burst requests is 10 per minute and maximum sustained requests is 1,000 per day.

The following functions are implemented:

• mywx_districts: Retrieve valid geopolitical entities (location)
• mywx_forecast: Retrieve forecast data for a location
• mywx_states: Retrieve valid geopolitical entities (location)
• mywx_touristdests: Retrieve valid geopolitical entities (location)
• mywx_towns: Retrieve valid geopolitical entities (location)

Installation

devtools::install_github("hrbrmstr/mywx")

options(width=120)

Usage

library(mywx)
library(tidyverse)

# current verison
packageVersion("mywx")

mywx_districts()

mywx_states()

mywx_towns()

mywx_touristdests()

glimpse(mywx_forecast("LOCATION:237", "2017-08-13", "2017-08-13"))

vals <- mywx_forecast("LOCATION:237", "2017-08-01", "2017-08-13")

glimpse(vals)

dplyr::filter(vals, datatype %in% c("FMINT", "FMAXT")) %>% 
  mutate(value = as.numeric(value)) %>% 
  ggplot(aes(date, value, color = datatype)) +
  geom_line()

Test Results

library(mywx)
library(testthat)

date()

test_dir("tests/")

hrbrmstr/mywx documentation built on May 31, 2019, 3:54 a.m.