galaaz 2.1.7 → 2.1.9

data/blogs/galaaz_ggplot/galaaz_ggplot.Rmd

@@ -8,9 +8,17 @@ output:
   html_document:
     self_contained: true
     keep_md: true
+    toc: true
+    toc_float: true
+    toc_depth: 2
+    number_sections: true
+    includes:
+      before_body: _logo_before_body.html
   pdf_document:
     includes:
-      in_header: "../../sty/galaaz.sty"
+      in_header:
+        - "../../sty/galaaz.sty"
+        - "../../sty/galaaz-headers-from-p3.tex"
     keep_tex: yes
     number_sections: yes
     toc: true
@@ -21,7 +29,13 @@ fontsize: 11pt
 ---
 
 ```{r setup, echo=FALSE}
+# Narrower console width so printed output fits PDF code boxes better.
+options(width = 70)
+```
 
+```{r brand_logo, echo=FALSE, fig.align='center', out.width='45%', eval=knitr::is_latex_output()}
+# PDF only — HTML uses _logo_before_body.html (above the TOC).
+knitr::include_graphics("images/galaaz-lockup-stacked.png")
 ```
 
 # Introduction
@@ -171,38 +185,43 @@ not use scientific notation and the preferred color is blue.
 ```{ruby global_theme_rb}
 # corp_theme.rb
 # defines the corporate theme for all plots
-    
+
 module CorpTheme
 
-  #---------------------------------------------------------------------------------
-  # Defines the plot theme (visualization).  In this theme we remove major and minor
-  # grids, borders and background.  We also turn-off scientific notation.
-  #---------------------------------------------------------------------------------
-  
+  # ---------------------------------------------------------------
+  # Plot theme: no major/minor grids, borders, or background;
+  # turn off scientific notation.
+  # ---------------------------------------------------------------
+
   def self.global_theme
-    
+
     R.options(scipen: 999)  # turn-off scientific notation like 1e+48
-    
+
     # remove major grids
-    global_theme = R.theme(panel__grid__major: E.element_blank())
+    global_theme =
+      R.theme(panel__grid__major: E.element_blank())
     # remove minor grids
-    global_theme = global_theme + R.theme(panel__grid__minor: E.element_blank)
+    global_theme = global_theme +
+      R.theme(panel__grid__minor: E.element_blank)
     # remove border
-    global_theme = global_theme + R.theme(panel__border: E.element_blank)
+    global_theme = global_theme +
+      R.theme(panel__border: E.element_blank)
     # remove background
-    global_theme = global_theme + R.theme(panel__background: E.element_blank)
+    global_theme = global_theme +
+      R.theme(panel__background: E.element_blank)
     # Change axis font
     global_theme = global_theme +
-                   R.theme(axis__text: E.element_text(size: 8, color: "#000080"))
+      R.theme(axis__text: E.element_text(
+                size: 8, color: "#000080"))
     # change color of axis titles
     global_theme = global_theme +
-                   R.theme(axis__title: E.element_text(
-                             color: "#000080", 
-                             face: "bold",
-                             size: 8,
-                             hjust: 1))
+      R.theme(axis__title: E.element_text(
+                color: "#000080",
+                face: "bold",
+                size: 8,
+                hjust: 1))
   end
-   
+
 end
 ```
 
@@ -211,7 +230,7 @@ We now define a ScatterPlot class:
 ```{ruby ScatterPlot_rb}
 # ScatterPlot.rb
 # creates a scatter plot and allow some configuration
-    
+
 class ScatterPlot
 
   attr_accessor :title
@@ -219,55 +238,55 @@ class ScatterPlot
   attr_accessor :caption
   attr_accessor :x_label
   attr_accessor :y_label
-  
-  #---------------------------------------------------------------------------------
+
+  # ---------------------------------------------------------------
   # Initialize the plot with the data and the x and y variables
-  #---------------------------------------------------------------------------------
+  # ---------------------------------------------------------------
 
   def initialize(data, x:, y:)
     @data = data
     @x = x
     @y = y
   end
-  
-  #---------------------------------------------------------------------------------
+
+  # ---------------------------------------------------------------
   # Define groupings by color and size
-  #---------------------------------------------------------------------------------
+  # ---------------------------------------------------------------
 
   def group_by(color:, size:)
     @color_by = color
     @size_by = size
   end
 
-  #---------------------------------------------------------------------------------
-  # Add a smoothing line, and if confidence is true the add a confidence interval, if
-  # false does not add the confidence interval
-  #---------------------------------------------------------------------------------
+  # ---------------------------------------------------------------
+  # Add a smoothing line; confidence: true draws a CI band.
+  # ---------------------------------------------------------------
 
   def add_smoothing_line(method:, confidence: true)
     @method = method
     @confidence = confidence
   end
-  
-  #---------------------------------------------------------------------------------
-  # Creates the graph title, properly formated for this theme
-  # @param title [String] The title to add to the graph
-  # @return textGrob that can be included in a graph
-  #---------------------------------------------------------------------------------
-
-  def graph_params(title: "", subtitle: "", caption: "", x_label: "", y_label: "")
+
+  # ---------------------------------------------------------------
+  # Graph title / labels, formatted for this theme.
+  # @param title [String] title to add to the graph
+  # @return labs() result that can be included in a graph
+  # ---------------------------------------------------------------
+
+  def graph_params(title: "", subtitle: "", caption: "",
+                   x_label: "", y_label: "")
     R.labs(
-      title: title, 
-      subtitle: subtitle, 
+      title: title,
+      subtitle: subtitle,
       caption: caption,
-      y_label: y_label, 
-      x_label: x_label, 
+      y_label: y_label,
+      x_label: x_label,
     )
   end
 
-  #---------------------------------------------------------------------------------
+  # ---------------------------------------------------------------
   # Prepare the plot's points
-  #---------------------------------------------------------------------------------
+  # ---------------------------------------------------------------
 
   def points
     params = {}
@@ -275,30 +294,28 @@ class ScatterPlot
     params[:size] = @size_by if @size_by
     R.geom_point(E.aes(params))
   end
-      
-  #---------------------------------------------------------------------------------
+
+  # ---------------------------------------------------------------
   # Plots the scatterplot
-  #---------------------------------------------------------------------------------
+  # ---------------------------------------------------------------
 
   def plot
     gg = @data.ggplot(E.aes(x: @x, y: @y)) +
-      points + 
+      points +
       R.geom_smooth(method: @method, se: @confidence) +
       R.xlim(R.c(0, 0.1)) +
-      R.ylim(R.c(0, 500000)) + 
+      R.ylim(R.c(0, 500000)) +
       graph_params(title: @title,
-                   subtitle: @subtitle, 
-                   y_label: @y_label, 
-                   x_label: @x_label, 
+                   subtitle: @subtitle,
+                   y_label: @y_label,
+                   x_label: @x_label,
                    caption: @caption) +
       CorpTheme.global_theme
 
     puts gg
-    
   end
-  
-end
 
+end
 ```
 
 And this is the final code for making the scatter plot with the midwest data
@@ -313,9 +330,10 @@ sp.subtitle = "Area Vs Population"
 sp.caption = "Source: midwest"
 sp.x_label = "Area"
 sp.y_label = "Population"
-sp.group_by(color: :state, size: :popdensity)    # try sp.group_by(color: :state)
+# try: sp.group_by(color: :state)
+sp.group_by(color: :state, size: :popdensity)
 # available methods: "lm", "glm", "loess", "gam"
-sp.add_smoothing_line(method: "glm") 
+sp.add_smoothing_line(method: "glm")
 sp.plot
 ```