fix purrr thing and widocumentation

R/api.R

@@ -186,6 +186,7 @@ hc_legend <- function(hc, ...) {
 #'   hc_add_serie(name = "Tokyo", data = citytemp$tokyo) %>% 
 #'   hc_add_serie(name = "London", data = citytemp$london) %>% 
 #'   hc_tooltip(crosshairs = TRUE, backgroundColor = "gray",
+#'              headerFormat = "This is a custom header<br>",
 #'              shared = TRUE, borderWidth = 5)
 #'              
 #' @param hc A \code{highchart} \code{htmlwidget} object. 
@@ -208,7 +209,34 @@ hc_tooltip <- function(hc, ...) {
 #' \code{hc_plotOptions(line = list(...))}. Next, options for one single series are given in the series array.
 #' 
 #' @param hc A \code{highchart} \code{htmlwidget} object. 
-#' @param ... Arguments are defined in \url{http://api.highcharts.com/highcharts#plotOptions}. 
+#' @param ... Arguments are defined in \url{http://api.highcharts.com/highcharts#plotOptions}.
+#' 
+#' @examples 
+#' 
+#' require("dplyr")
+#' 
+#' data(citytemp)
+#' 
+#' hc <- highchart() %>% 
+#'   hc_plotOptions(line = list(color = "blue",
+#'                              marker = list(
+#'                                fillColor = "white",
+#'                                lineWidth = 2,
+#'                                lineColor = NULL
+#'                                )
+#'   )) %>%  
+#'   hc_add_serie(name = "Tokyo", data = citytemp$tokyo) %>% 
+#'   hc_add_serie(name = "London", data = citytemp$london,
+#'                marker = list(fillColor = "black"))
+#' 
+#' 
+#' hc
+#' 
+#' #' override the `blue` option with the explicit parameter
+#' hc %>% 
+#'   hc_add_serie(name = "London",
+#'                data = citytemp$new_york,
+#'                color = "red")
 #'
 #' @export
 hc_plotOptions  <- function(hc, ...) {
@@ -219,7 +247,7 @@ hc_plotOptions  <- function(hc, ...) {
 
 #' Adding Color Axis options to highchart objects
 #'
-#' 
+#' Function to set the axis color to highcharts objects.
 #' 
 #' @param hc A \code{highchart} \code{htmlwidget} object. 
 #' @param ... Arguments are defined in \url{http://www.highcharts.com/docs/maps/color-axis}. 

R/shortcuts.R

@@ -298,11 +298,13 @@ hc_add_serie_treemap <- function(hc, tm, ...) {
     tbl_df() %>% 
     select_("-x0", "-y0", "-w", "-h", "-stdErr", "-vColorValue") %>% 
     rename_("value" = "vSize", "valuecolor" = "vColor") %>% 
-    map_if(is.factor, as.character)
+    purrr::map_if(is.factor, as.character) %>% 
+    data.frame(stringsAsFactors = FALSE) %>% 
+    tbl_df()
 
   ndepth <- which(names(df) == "value") - 1
 
-  ds <- ldply(seq(ndepth), function(lvl){ # lvl <- sample(size = 1, seq(ndepth))
+  ds <- ldply(seq(ndepth), function(lvl){ # lvl <- sample(seq(ndepth), size = 1)
 
     df2 <- df %>% 
       filter_(sprintf("level == %s", lvl)) %>% 

R/theme.R

@@ -1,35 +1,15 @@
-#' Add themes to a highchart object
-#' 
-#' Add highcharts themes to a highchart object.
-#' 
-#' @param hc A highchart object
-#' @param hc_thm A highchart theme object (\code{"hc_theme"} class)
-#' @export
-hc_add_theme <- function(hc, hc_thm){
-
-  assert_that(.is_highchart(hc),
-              .is_hc_theme(hc_thm))
-
-  hc$x$fonts <- unique(c(hc$x$fonts, .hc_get_fonts(hc_thm)))
-
-  hc$x$theme <- hc_thm
-
-  hc
-
-}
-
 #' Highchart theme constructor
 #' 
 #' Function to create highcharts themes.
 #' 
-#' @param ... Usually named list
+#' @param ... A named list with the parameters.
 #' 
 #' @examples 
 #' 
-#' \dontrun{
+#' require("dplyr")
 #' 
 #' hc <- highchart(debug = TRUE) %>% 
-#'   hc_add_serie_scatter(mtcars$wt, mtcars$mpg, mtcars$cyl) %>% 
+#'   hc_add_serie_scatter(mtcars$wt, mtcars$mpg, color = mtcars$cyl) %>% 
 #'   hc_chart(zoomType = "xy") %>% 
 #'   hc_title(text = "Motor Trend Car Road Tests") %>% 
 #'   hc_subtitle(text = "Motor Trend Car Road Tests") %>% 
@@ -70,36 +50,39 @@ hc_add_theme <- function(hc, hc_thm){
 #' 
 #' hc %>% hc_add_theme(thm)
 #' 
-#' }
-#' 
 #' @export
 hc_theme <- function(...){
 
   structure(list(...), class = "hc_theme")
 
 }
 
-#' @importFrom stringr str_replace_all str_replace str_trim
-.hc_get_fonts <- function(lst){
+#' Add themes to a highchart object
+#' 
+#' Add highcharts themes to a highchart object.
+#' 
+#' @param hc A highchart object
+#' @param hc_thm A highchart theme object (\code{"hc_theme"} class)
+#' 
+#' @export
+hc_add_theme <- function(hc, hc_thm){
 
-  unls <- unlist(lst)
-  unls <- unls[grepl("fontFamily", names(unls))]
+  assert_that(.is_highchart(hc),
+              .is_hc_theme(hc_thm))
 
-  fonts <- unls %>% 
-    str_replace_all(",\\s+sans-serif|,\\s+serif", "") %>% 
-    str_replace("\\s+", "+") %>% 
-    str_trim() %>% 
-    unlist()
+  hc$x$fonts <- unique(c(hc$x$fonts, .hc_get_fonts(hc_thm)))
 
-  fonts
+  hc$x$theme <- hc_thm
+
+  hc
 
 }
 
 #' Merge themes
 #' 
 #' Function to combine hc_theme objects.
 #' 
-#' @param ... \code{hc_theme} objects
+#' @param ... A \code{hc_theme} objects.
 #' 
 #' @export
 hc_theme_merge <- function(...){
@@ -113,3 +96,19 @@ hc_theme_merge <- function(...){
   theme
 
 }
+
+#' @importFrom stringr str_replace_all str_replace str_trim
+.hc_get_fonts <- function(lst){
+
+  unls <- unlist(lst)
+  unls <- unls[grepl("fontFamily", names(unls))]
+
+  fonts <- unls %>% 
+    str_replace_all(",\\s+sans-serif|,\\s+serif", "") %>% 
+    str_replace("\\s+", "+") %>% 
+    str_trim() %>% 
+    unlist()
+
+  fonts
+
+}

R/zzz.R

@@ -18,13 +18,15 @@
       drillUpText = "Back to list(series.name)",
       invalidDate = NULL,
       loading = "Loading...",
-      months = c( "January" , "February" , "March" , "April" , "May" , "June" , "July" , "August" , "September" , "October" , "November" , "December"),
+      months = c( "January" , "February" , "March" , "April" , "May" , "June" ,
+                  "July" , "August" , "September" , "October" , "November" , "December"),
       noData = "No data to display",
       numericSymbols = c( "k" , "M" , "G" , "T" , "P" , "E"),
       printChart = "Print chart",
       resetZoom = "Reset zoom",
       resetZoomTitle = "Reset zoom level 1:1",
-      shortMonths = c( "Jan" , "Feb" , "Mar" , "Apr" , "May" , "Jun" , "Jul" , "Aug" , "Sep" , "Oct" , "Nov" , "Dec"),
+      shortMonths = c( "Jan" , "Feb" , "Mar" , "Apr" , "May" , "Jun" ,
+                       "Jul" , "Aug" , "Sep" , "Oct" , "Nov" , "Dec"),
       thousandsSep = " ",
       weekdays = c("Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday")
     ),

no_build/index.R

@@ -293,31 +293,17 @@ hc
 
 ##' # Shorcuts for add Data (data series) ####
 
-##' ## Time Series ####
-
-data(economics, package = "ggplot2")
-
-highchart() %>% 
-  hc_add_serie_ts(economics$psavert, economics$date,
-                  name = "Personal Savings Rate")
-
-#' There's a `hc_add_serie_ts2` which recieve a `ts`object.
-
-highchart() %>% 
-  hc_add_serie_ts2(AirPassengers, color = "#26838E")
-
-highchart() %>% 
-  hc_title(text = "Monthly Deaths from Lung Diseases in the UK") %>% 
-  hc_subtitle(text = "Deaths from bronchitis, emphysema and asthma") %>% 
-  hc_add_serie_ts2(fdeaths, name = "Female") %>%
-  hc_add_serie_ts2(mdeaths, name = "Male")
-
-##' ## Scatter plot ####
+##' ## Scatter ####
 
 highchart() %>% 
   hc_title(text = "Simple scatter chart") %>% 
   hc_add_serie_scatter(mtcars$wt, mtcars$mpg)
 
+highchart() %>% 
+  hc_title(text = "Scatter chart with color") %>% 
+  hc_add_serie_scatter(mtcars$wt, mtcars$mpg,
+                       color = mtcars$hp)
+
 highchart() %>% 
   hc_title(text = "Scatter chart with size") %>% 
   hc_add_serie_scatter(mtcars$wt, mtcars$mpg,
@@ -328,11 +314,6 @@ highchart() %>%
   hc_add_serie_scatter(mtcars$wt, mtcars$mpg,
                        mtcars$drat, mtcars$hp)
 
-highchart() %>% 
-  hc_title(text = "Scatter chart with color and no size") %>% 
-  hc_add_serie_scatter(mtcars$wt, mtcars$mpg,
-                       color = mtcars$hp)
-
 highchart(height = 500) %>% 
   hc_title(text = "A complete example for Scatter") %>% 
   hc_add_serie_scatter(mtcars$wt, mtcars$mpg,
@@ -352,7 +333,7 @@ highchart(height = 500) %>%
                                  "<tr><th>HP</th><td>{point.valuecolor} hp</td></tr>"),
              footerFormat = "</table>")
 
-# or We can add series one by one.
+#' Or we can add series one by one.
 hc <- highchart()
 for (cyl in unique(mtcars$cyl)) {
   hc <- hc %>%
@@ -364,6 +345,25 @@ for (cyl in unique(mtcars$cyl)) {
 
 hc
 
+##' ## Time Series ####
+
+data(economics, package = "ggplot2")
+
+highchart() %>% 
+  hc_add_serie_ts(economics$psavert, economics$date,
+                  name = "Personal Savings Rate")
+
+#' There's a `hc_add_serie_ts2` which recieve a `ts`object.
+
+highchart() %>% 
+  hc_add_serie_ts2(AirPassengers, color = "#26838E")
+
+highchart() %>% 
+  hc_title(text = "Monthly Deaths from Lung Diseases in the UK") %>% 
+  hc_subtitle(text = "Deaths from bronchitis, emphysema and asthma") %>% 
+  hc_add_serie_ts2(fdeaths, name = "Female") %>%
+  hc_add_serie_ts2(mdeaths, name = "Male")
+
 ##' ## Treemaps ####
 #'
 #' Here we use the `treemap` package to create a treemap object and then