Merge branch 'develop'

Author: crazycapivara

DESCRIPTION

@@ -1,9 +1,12 @@
 Package: owmr
 Title: OpenWeatherMap API Wrapper
-Version: 0.7.0
+Version: 0.7.2
 Authors@R: person("Stefan", "Kuethe", email = "crazycapivara@gmail.com", role = c("aut", "cre"))
-Description: An R Interface to OpenWeatherMap.
-   Beside functions for fetching weather data from owm, owmr supplies
+Description: Accesses OpenWeatherMap's (owm) <https://openweathermap.org/> API.
+   'owm' itself is a service providing weather data in the past, in the future and now.
+   Furthermore, 'owm' serves weather map layers usable in frameworks like 'leaflet'.
+   In order to access the API, you need to sign up for an API key. There are free and paid plans.
+   Beside functions for fetching weather data from 'owm', 'owmr' supplies
    tools to tidy up fetched data (for fast and simple access) and to show it on leaflet maps.
 URL:
   https://github.com/crazycapivara/owmr/,

LICENSE

@@ -1,2 +1,2 @@
 YEAR: 2016-2017
-COPYRIGHT HOLDER: Stefan Kuethe, Kassel
+COPYRIGHT HOLDER: Stefan Kuethe

NEWS.md

@@ -27,3 +27,11 @@
 
 * Added functions to add owm tiles to leaflet map.
   - Note: Performance of owm tile server seems to be low.
+
+# owmr 0.7.1
+
+* Fixed false poitives in check for undefined global variable `.` from `magrittr`
+
+# owmr 0.7.2
+
+* Updated package description

R/package.R

@@ -1,4 +1,9 @@
-#' owmr - An R interface to OpenWeatherMap
+#' owmr - An R interface to access OpenWeatherMap's API
+#'
+#' In order to access the API, you need to sign up for an API key
+#' at \url{https://openweathermap.org/}. \cr
+#' For optional parameters (\code{...}) in functions see
+#' \url{https://openweathermap.org/api/}
 #'
 #' @name owmr
 #'

R/tidy_up-parse_columns.R

@@ -9,7 +9,7 @@
 #' @examples\dontrun{
 #'    parse_dt <- function(x){as.POSIXct(x, origin = "1970-01-01")}
 #'    forecast <- get_forecast("Kassel")$list
-#'    forecast %<>% parse_result(list(dt = parse_dt))
+#'    forecast %<>% parse_columns(list(dt = parse_dt))
 #' }
 parse_columns <- function(data, functions_){
   for(name in names(functions_)){

R/tidy_up-remove_prefix.R

@@ -10,7 +10,7 @@
 #' @examples
 #' x <- data.frame(main.temp = 1:10, sys.msg = "OK", cnt = 10:1)
 #' names(x)
-#' remove_prefix(x, c("main", "sys")) %>% names
+#' remove_prefix(x, c("main", "sys")) %>% names()
 remove_prefix <- function(data, prefices, sep = "."){
   for(prefix in prefices){
     prefix <- paste0(prefix, sep)

R/tidy_up-use_underscore.R

@@ -7,7 +7,7 @@
 #'
 #' @examples
 #' names(airquality)
-#' use_underscore(airquality) %>% names
+#' use_underscore(airquality) %>% names()
 use_underscore <-function(data){
   names(data) <- gsub("\\.", "_", names(data))
   data

R/zzz.R

@@ -1,8 +1,10 @@
 .onAttach <- function(libname, pkgname){
   packageStartupMessage(
     pkgname, " ", getNamespaceVersion(pkgname), "\n",
-    "   another crazy way to talk to OpenWeatherMap's api\n",
+    "   another crazy way to talk to OpenWeatherMap's API\n",
     "   Documentation: type ?owmr or https://crazycapivara.github.io/owmr/\n",
     "   Issues, notes and bleeding edge: https://github.com/crazycapivara/owmr/\n"
   )
 }
+
+globalVariables(".")

README.md

@@ -1,6 +1,12 @@
-OpenWeatherMap Api Wrapper for R
+An R Interface to OpenWeatherMap
 ================
 
+[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/owmr)](https://cran.r-project.org/package=owmr)
+
+`owmr` accesses **OpenWeatherMap's** API, a service providing weather data in the past, in the future and now and furthermore, serving weather map layers usable in frameworks like `leaflet`. In order to access its API you have to sign up for an API key at
+
+-   <https://openweathermap.org>
+
 Builds
 ------
 
@@ -25,21 +31,22 @@ install_github("crazycapivara/owmr")
 install_github("crazycapivara/owmr", ref = "develop")
 ```
 
-Current version
----------------
+Introduction
+------------
+
+See **OpenWeatherMap's** API documentation for optional parameters, which can be passed to all functions fetching weather data via the `...` parameter in R
+
+-   <https://openweathermap.org/api/>
 
 ``` r
 library(owmr)
 ```
 
-    ## owmr 0.7.0
-    ##    another crazy way to talk to OpenWeatherMap's api
+    ## owmr 0.7.2
+    ##    another crazy way to talk to OpenWeatherMap's API
     ##    Documentation: type ?owmr or https://crazycapivara.github.io/owmr/
     ##    Issues, notes and bleeding edge: https://github.com/crazycapivara/owmr/
 
-Introduction
-------------
-
 ``` r
 # pass api key
 api_key_ = "your-api-key"
@@ -71,10 +78,10 @@ res[c("coord.lon", "coord.lat", "main.temp", "weather.description")]
     ## [1] 51.51
     ## 
     ## $main.temp
-    ## [1] 6.92
+    ## [1] 4.01
     ## 
     ## $weather.description
-    ## [1] "broken clouds"
+    ## [1] "moderate rain"
 
 ``` r
 # ... by city id
@@ -106,13 +113,13 @@ get_current(rio$id, units = "metric") %>%
     ## [1] "Rio de Janeiro"
     ## 
     ## $main.temp
-    ## [1] 33.98
+    ## [1] 28.73
     ## 
     ## $main.humidity
-    ## [1] 56
+    ## [1] 70
     ## 
     ## $wind.speed
-    ## [1] 6.7
+    ## [1] 2.6
 
 ``` r
 # get weather data from stations
@@ -121,13 +128,13 @@ find_stations_by_geo_point(lat = 51.31667, lon = 9.5, cnt = 7) %>%
 ```
 
     ##   distance station.id station.name last.main.temp
-    ## 1   13.276       4926         EDVK         273.15
-    ## 2   26.926       4954         ETHF         273.15
+    ## 1   13.276       4926         EDVK         274.15
+    ## 2   26.926       4954         ETHF         276.15
     ## 3   69.579       4910         EDLP         275.15
-    ## 4   89.149      73733    Uwe Kruse         274.85
-    ## 5   93.344 1460732694        hlw31         273.15
+    ## 4   89.149      73733    Uwe Kruse         275.55
+    ## 5   93.344 1460732694        hlw31         275.43
     ## 6   97.934 1442728908         AmiH         273.15
-    ## 7   98.978       4951         ETHB         275.15
+    ## 7   98.978       4951         ETHB         276.15
 
 ``` r
 # get forecast
@@ -145,7 +152,7 @@ names(forecast)
     cnt  = forecast$cnt) %>% cat()
 ```
 
-    ## name: London, id: 2643743, (forcast) rows: 40
+    ## name: London, id: 2643743, (forcast) rows: 35
 
 ``` r
 names(forecast$list)
@@ -164,12 +171,12 @@ forecast$list[c("dt_txt", "main.temp", "main.temp_max", "wind.speed")] %>%
 ```
 
     ##                dt_txt main.temp main.temp_max wind.speed
-    ## 1 2017-01-10 21:00:00      6.17          6.17       3.33
-    ## 2 2017-01-11 00:00:00      6.38          6.38       3.31
-    ## 3 2017-01-11 03:00:00      6.05          6.05       4.08
-    ## 4 2017-01-11 06:00:00      7.51          7.51       5.57
-    ## 5 2017-01-11 09:00:00      9.12          9.12       6.25
-    ## 6 2017-01-11 12:00:00      8.60          8.60       7.17
+    ## 1 2017-01-14 15:00:00      4.74          5.04       4.81
+    ## 2 2017-01-14 18:00:00      3.38          3.60       3.65
+    ## 3 2017-01-14 21:00:00      3.38          3.52       3.97
+    ## 4 2017-01-15 00:00:00      0.71          0.78       4.67
+    ## 5 2017-01-15 03:00:00     -0.39         -0.39       3.95
+    ## 6 2017-01-15 06:00:00     -0.55         -0.55       2.97
 
 ``` r
 # flatten weather column and tidy up column names
@@ -190,15 +197,15 @@ names(forecast$list)
 forecast$list %<>% parse_columns(list(temp = round, wind_speed = round))
 
 # do some templating ...
-("{{dt_txt}}h {{temp}} °C, {{wind_speed}} m/s" %$$%
+("{{dt_txt}}h {{temp}}°C, {{wind_speed}} m/s" %$$%
   forecast$list) %>% head(10)
 ```
 
-    ##  [1] "2017-01-10 21:00:00h 6 °C, 3 m/s" "2017-01-11 00:00:00h 6 °C, 3 m/s"
-    ##  [3] "2017-01-11 03:00:00h 6 °C, 4 m/s" "2017-01-11 06:00:00h 8 °C, 6 m/s"
-    ##  [5] "2017-01-11 09:00:00h 9 °C, 6 m/s" "2017-01-11 12:00:00h 9 °C, 7 m/s"
-    ##  [7] "2017-01-11 15:00:00h 8 °C, 7 m/s" "2017-01-11 18:00:00h 7 °C, 6 m/s"
-    ##  [9] "2017-01-11 21:00:00h 6 °C, 6 m/s" "2017-01-12 00:00:00h 6 °C, 6 m/s"
+    ##  [1] "2017-01-14 15:00:00h 5°C, 5 m/s"  "2017-01-14 18:00:00h 3°C, 4 m/s" 
+    ##  [3] "2017-01-14 21:00:00h 3°C, 4 m/s"  "2017-01-15 00:00:00h 1°C, 5 m/s" 
+    ##  [5] "2017-01-15 03:00:00h 0°C, 4 m/s"  "2017-01-15 06:00:00h -1°C, 3 m/s"
+    ##  [7] "2017-01-15 09:00:00h 1°C, 3 m/s"  "2017-01-15 12:00:00h 3°C, 3 m/s" 
+    ##  [9] "2017-01-15 15:00:00h 6°C, 5 m/s"  "2017-01-15 18:00:00h 7°C, 4 m/s"
 
 Documentation
 -------------
@@ -226,6 +233,6 @@ test_dir("tests/testthat/")
     ## parse columns: ..
     ## render operator: ...
     ## current weather data from multiple stations: ...
-    ## tidy up data: ...
+    ## tidy up data: ....
     ## 
     ## DONE ======================================================================

README.rmd

@@ -1,5 +1,5 @@
 ---
-title: "OpenWeatherMap Api Wrapper for R"
+title: "An R Interface to OpenWeatherMap"
 output: github_document
 ---
 
@@ -10,6 +10,12 @@ library(magrittr)
 source("tmp/settings.R")
 ```
 
+[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/owmr)](https://cran.r-project.org/package=owmr)
+
+`owmr` accesses __OpenWeatherMap's__ API, a service providing weather data in the past, in the future and now and furthermore, serving weather map layers usable in frameworks like `leaflet`. In order to access its API you have to sign up for an API key at
+
+* https://openweathermap.org
+
 ## Builds
 
 __master__
@@ -26,21 +32,24 @@ __develop__
 require("devtools")
 
 # stable
-install_github("crazycapivara/owmr")
+install.packages("owmr")
+
+# unstable
+install_github("crazycapivara/owmr/")
 
 # bleeding edge
-install_github("crazycapivara/owmr", ref = "develop")
+install_github("crazycapivara/owmr/", ref = "develop")
 ```
 
-## Current version
+## Introduction
 
-```{r version, echo=TRUE, eval=TRUE}
-library(owmr)
-```
+See __OpenWeatherMap's__ API documentation for optional parameters, which can be passed to all functions fetching weather data via the `...` parameter in R
 
-## Introduction
+* https://openweathermap.org/api/
 
 ```{r introduction, echo=TRUE, eval=TRUE}
+library(owmr)
+
 # pass api key
 api_key_ = "your-api-key"
 owmr_settings(api_key = api_key)
@@ -84,7 +93,7 @@ names(forecast$list)
 forecast$list %<>% parse_columns(list(temp = round, wind_speed = round))
 
 # do some templating ...
-("{{dt_txt}}h {{temp}} °C, {{wind_speed}} m/s" %$$%
+("{{dt_txt}}h {{temp}}°C, {{wind_speed}} m/s" %$$%
   forecast$list) %>% head(10)
 ```