Merge pull request #19 from ModelOriented/master

update branch
ModelOriented · May 16, 2019 · 46ca933 · 46ca933
2 parents 3da3022 + df2a2e5
commit 46ca933
Show file tree

Hide file tree

Showing 49 changed files with 407 additions and 186 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: ingredients
 Title: Effects and Importances of Model Ingredients
-Version: 0.3.2
+Version: 0.3.3
 Authors@R: c(person("Przemyslaw", "Biecek", email = "przemyslaw.biecek@gmail.com", 
                   role = c("aut", "cre"),
                   comment = c(ORCID = "0000-0001-8423-1823")),

diff --git a/NAMESPACE b/NAMESPACE
@@ -44,7 +44,7 @@ export(partial_dependency)
 export(plotD3)
 export(select_neighbours)
 export(select_sample)
-export(show_aggreagated_profiles)
+export(show_aggregated_profiles)
 export(show_observations)
 export(show_profiles)
 export(show_residuals)

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,9 @@
+ingredients 0.3.3
+----------------------------------------------------------------
+* `show_profiles` and `show_residuals` functions extend Ceteris Paribus Plots.
+* `show_aggreagated_profiles` is renamed to `show_aggregated_profiles`
+* centering of ggplot2 title
+
 ingredients 0.3.2
 ----------------------------------------------------------------
 * added new functions `describe()` and `print.ceteris_paribus_descriptions()` for text based descriptions of Ceteris Paribus explainers

diff --git a/R/aggreagate_profiles.R b/R/aggreagate_profiles.R
@@ -46,7 +46,7 @@
 #' plot(cp_rf, variables = "age") +
 #'   show_observations(cp_rf, variables = "age") +
 #'   show_rugs(cp_rf, variables = "age", color = "red") +
-#'   show_aggreagated_profiles(pdp_rf, size = 3, color = "_label_")
+#'   show_aggregated_profiles(pdp_rf, size = 3, color = "_label_")
 #' }
 #' @export
 aggregate_profiles <- function(x, ...,

diff --git a/R/cluster_profiles.R b/R/cluster_profiles.R
@@ -51,10 +51,10 @@
 #' head(clust_rf)
 #'
 #' plot(clust_rf, color = "_label_") +
-#'   show_aggreagated_profiles(pdp_rf, color = "black", size = 3)
+#'   show_aggregated_profiles(pdp_rf, color = "black", size = 3)
 #'
 #' plot(cp_rf, color = "grey", variables = "age") +
-#'   show_aggreagated_profiles(clust_rf, color = "_label_", size = 2)
+#'   show_aggregated_profiles(clust_rf, color = "_label_", size = 2)
 #'
 #' clust_rf <- cluster_profiles(cp_rf, k = 3, center = TRUE, variables = "age")
 #' head(clust_rf)

diff --git a/R/plot_aggregated_ceteris_paribus_explainer.R b/R/plot_aggregated_ceteris_paribus_explainer.R
@@ -1,6 +1,6 @@
 #' Adds a Layer with Aggregated Profiles
 #'
-#' Function 'show_aggreagated_profiles' adds a layer to a plot created with 'plot.ceteris_paribus_explainer'.
+#' Function 'show_aggregated_profiles' adds a layer to a plot created with 'plot.ceteris_paribus_explainer'.
 #'
 #' @param x a ceteris paribus explainer produced with function `ceteris_paribus()`
 #' @param ... other explainers that shall be plotted together
@@ -62,7 +62,7 @@
 #' plot(cp_rf, variables = "age") +
 #'   show_observations(cp_rf, variables = "age") +
 #'   show_rugs(cp_rf, variables = "age", color = "red") +
-#'   show_aggreagated_profiles(pdp_rf_p, size = 2)
+#'   show_aggregated_profiles(pdp_rf_p, size = 2)
 #'
 #' }
 #' @export

diff --git a/R/show_aggregated_profiles.R b/R/show_aggregated_profiles.R
@@ -1,6 +1,6 @@
 #' Adds a Layer with Aggregated Profiles
 #'
-#' Function 'show_aggreagated_profiles' adds a layer to a plot created with 'plot.ceteris_paribus_explainer'.
+#' Function 'show_aggregated_profiles' adds a layer to a plot created with 'plot.ceteris_paribus_explainer'.
 #'
 #' @param x a ceteris paribus explainer produced with function `ceteris_paribus()`
 #' @param ... other explainers that shall be plotted together
@@ -27,7 +27,7 @@
 #' pdp_rf <- aggregate_profiles(cp_rf, variables = "age")
 #' plot(cp_rf, variables = "age") +
 #'   show_observations(cp_rf, variables = "age") +
-#'   show_aggreagated_profiles(pdp_rf, size = 3)
+#'   show_aggregated_profiles(pdp_rf, size = 3)
 #'
 #'  \donttest{
 #' library("randomForest")
@@ -48,13 +48,13 @@
 #' plot(cp_rf, variables = "age") +
 #'   show_observations(cp_rf, variables = "age") +
 #'   show_rugs(cp_rf, variables = "age", color = "red") +
-#'   show_aggreagated_profiles(pdp_rf, size = 3)
+#'   show_aggregated_profiles(pdp_rf, size = 3)
 #'
 #' plot(pdp_rf, variables = "age", color = "grey")
 #'
 #' }
 #' @export
-show_aggreagated_profiles <- function(x, ...,
+show_aggregated_profiles <- function(x, ...,
                       size = 0.5,
                       alpha = 1,
                       color = "#371ea3",

diff --git a/R/show_rugs.R b/R/show_rugs.R
@@ -30,7 +30,7 @@
 #' pdp_rf <- aggregate_profiles(cp_rf, variables = "age")
 #' plot(cp_rf, variables = "age") +
 #'   show_observations(cp_rf, variables = "age") +
-#'   show_aggreagated_profiles(pdp_rf, size = 3)
+#'   show_aggregated_profiles(pdp_rf, size = 3)
 #'
 #'  \donttest{
 #' library("randomForest")
@@ -51,7 +51,7 @@
 #' plot(cp_rf, variables = "age") +
 #'   show_observations(cp_rf, variables = "age") +
 #'   show_rugs(cp_rf, variables = "age", color = "red") +
-#'   show_aggreagated_profiles(pdp_rf, size = 3)
+#'   show_aggregated_profiles(pdp_rf, size = 3)
 #'
 #' plot(pdp_rf, variables = "age", color = "grey")
 #'

diff --git a/R/theme_drwhy.R b/R/theme_drwhy.R
@@ -15,8 +15,8 @@ theme_drwhy <- function() {
           axis.line.y = element_line(color = "white"),
           axis.ticks.y = element_line(color = "white"),
           #axis.line = element_line(color = "#371ea3", size = 0.5, linetype = 1),
-          plot.title = element_text(color = "#371ea3", size = 16),
-          plot.subtitle = element_text(color = "#371ea3", size = 14),
+          plot.title = element_text(color = "#371ea3", size = 16, hjust = 0),
+          plot.subtitle = element_text(color = "#371ea3", size = 14, hjust = 0),
           axis.title = element_text(color = "#371ea3"),
           axis.text = element_text(color = "#371ea3", size = 10),
           strip.text = element_text(color = "#371ea3", size = 12, hjust = 0, margin = margin(0, 0, 1, 0)),
@@ -36,8 +36,8 @@ theme_drwhy_vertical <- function() {
           legend.direction = "horizontal", legend.position = "top",
           axis.line.x = element_line(color = "white"),
           axis.ticks.x = element_line(color = "white"),
-          plot.title = element_text(color = "#371ea3", size = 16),
-          plot.subtitle = element_text(color = "#371ea3", size = 14),
+          plot.title = element_text(color = "#371ea3", size = 16, hjust = 0),
+          plot.subtitle = element_text(color = "#371ea3", size = 14, hjust = 0),
           #axis.line = element_line(color = "#371ea3", size = 0.5, linetype = 1),
           axis.title = element_text(color = "#371ea3"),
           axis.text = element_text(color = "#371ea3", size = 10),
@@ -56,8 +56,8 @@ theme_drwhy_blank <- function() {
           panel.border = element_blank(), strip.background = element_blank(),
           plot.background = element_blank(), complete = TRUE,
           legend.direction = "horizontal", legend.position = "top",
-          plot.title = element_text(color = "#371ea3", size = 16),
-          plot.subtitle = element_text(color = "#371ea3", size = 14),
+          plot.title = element_text(color = "#371ea3", size = 16, hjust = 0),
+          plot.subtitle = element_text(color = "#371ea3", size = 14, hjust = 0),
           axis.line.x = element_line(color = "white"),
           axis.ticks.x = element_line(color = "white"),
           axis.title = element_text(color = "#371ea3"),

diff --git a/docs/articles/vignette_titanic.html b/docs/articles/vignette_titanic.html
diff --git a/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-10-1.png b/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-10-1.png
diff --git a/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-4-1.png b/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-4-1.png
diff --git a/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-5-1.png b/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-5-1.png
diff --git a/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-6-1.png b/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-6-1.png
diff --git a/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-7-1.png b/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-7-1.png
diff --git a/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-8-1.png b/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-8-1.png
diff --git a/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-9-1.png b/docs/articles/vignette_titanic_files/figure-html/unnamed-chunk-9-1.png
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/reference/aggregate_profiles.html b/docs/reference/aggregate_profiles.html
diff --git a/docs/reference/cluster_profiles.html b/docs/reference/cluster_profiles.html
diff --git a/docs/reference/feature_importance-5.png b/docs/reference/feature_importance-5.png
diff --git a/docs/reference/feature_importance.html b/docs/reference/feature_importance.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/partial_dependency-1.png b/docs/reference/partial_dependency-1.png
diff --git a/docs/reference/partial_dependency-2.png b/docs/reference/partial_dependency-2.png
diff --git a/docs/reference/partial_dependency-3.png b/docs/reference/partial_dependency-3.png
diff --git a/docs/reference/partial_dependency.html b/docs/reference/partial_dependency.html
diff --git a/docs/reference/plot.aggregated_profiles_explainer-1.png b/docs/reference/plot.aggregated_profiles_explainer-1.png
diff --git a/docs/reference/plot.aggregated_profiles_explainer-2.png b/docs/reference/plot.aggregated_profiles_explainer-2.png
diff --git a/docs/reference/plot.aggregated_profiles_explainer-3.png b/docs/reference/plot.aggregated_profiles_explainer-3.png
diff --git a/docs/reference/plot.aggregated_profiles_explainer-4.png b/docs/reference/plot.aggregated_profiles_explainer-4.png