support for more precise geocode (closes #25)

NEWS.md

@@ -1,5 +1,7 @@
 # grtrends 1.3.2 (unreleased)
 
+- Added support for sub-countries (#25). Ex.: `gtrends("NHL", geo = "CA-QC")` will return trends data for Québec province in Canada. The list of supported sub-countries can be obtained via `data(countries)`.
+
 - Data parsing should work for any data returned by Google Trends (i.e. countries independent).
 
 - Better support for queries using keywords in different languages (#50, #57). Ex.: `gtrends("蘋果", geo = "TW")`

R/countries.R

@@ -1,13 +1,16 @@
 #' Word countries ISO code.
 #'
 #' \itemize{
-#'   \item CODE  ISO 3 characters codes
-#'   \item COUNTRY Full countries names
+#'   \item code  ISO 3 characters codes
+#'   \item country Full countries names
+#'   \item subcode Countries subcodes
+#'   \item subname Countries subname
 #' }
 #' 
 #' @docType data
 #' @keywords datasets
 #' @name countries
 #' @usage data("countries")
-#' @format A data frame with 244 rows and 2 variables
+#' @format A data frame with 4707 rows and 4 variables
+#' @references \url{http://www.unece.org/cefact/codesfortrade/codes_index.html}
 NULL

R/gtrends.R

@@ -259,9 +259,9 @@ gtrends.default <- function(query,
 
   countries[, 1] <- as.character(countries[, 1])
   countries[, 2] <- as.character(countries[, 2])
-  countries[which(countries[, "COUNTRY"] == "Namibia"), "CODE"] <- "NA"
+  countries[which(countries[, "country"] == "Namibia"), "code"] <- "NA"
 
-  if (geo != "" && !all(geo %in% countries[, "CODE"])) {
+  if (geo != "" && !all(geo %in% countries[, "code"]) && !all(geo %in% countries[, "subcode"])) {
     stop("Country code not valid. Please use 'data(countries)' to retreive valid codes.",
          call. = FALSE)
   }
@@ -382,9 +382,8 @@ plot.gtrends <- function(x, type = c("trend", "geo"), which = 5, ind = 1L, ...){
 
     # Try to find if the requested block contains geographic information.
     data(locations, envir = environment())
-    loc <- locations
 
-    if(!any(tolower(block[1, ]) %in% tolower(loc$Name))){
+    if(!any(tolower(block[1, ]) %in% tolower(locations$Name))){
 
       message("The requested block does not seems to contain geographical information. Please choose another block.")
 

R/sport_trend.R

@@ -24,7 +24,7 @@
 #' @examples
 #' \dontrun{
 #' ch <- gconnect("usr@gmail.com", "psw")
-#' sport_trend <- gtrends(c("nhl", "nba", "nfl"))
+#' sport_trend <- gtrends(c("nhl", "nba", "nfl"), geo = "US")
 #' }
 #' 
 #' data("sport_trend")