Deployed e94e500 to 4.10 with MkDocs 1.6.1 and mike 2.1.3

4.10/advanced_settings/tables/config_correlations.csv

@@ -0,0 +1,19 @@
+Parameter,Type,Default,Description
+``correlations.auto.calculate``,boolean,``True``,"Whether to compute 'auto' correlation"
+``correlations.auto.warn_high_correlations``,boolean,``True``,"Show warning for correlations higher than the threshold"
+``correlations.auto.threshold``,float,0.9,"Warning threshold"
+``correlations.pearson.calculate``,boolean,``False``,"Whether to calculate Pearson correlation"
+``correlations.pearson.warn_high_correlations``,boolean,``True``,"Show warning for correlations higher than the threshold"
+``correlations.pearson.threshold``,float,0.9,"Warning threshold"
+``correlations.spearman.calculate``,boolean,``False``,"Whether to calculate Spearman correlation"
+``correlations.spearman.warn_high_correlations``,boolean,``False``,"Show warning for correlations higher than the threshold"
+``correlations.spearman.threshold``,float,0.9,"Warning threshold"
+``correlations.kendall.calculate``,boolean,``False``,"Whether to calculate Kendall rank correlation"
+``correlations.kendall.warn_high_correlations``,boolean,``False``,"Show warning for correlations higher than the threshold"
+``correlations.kendall.threshold``,float,0.9,"Warning threshold"
+``correlations.phi_k.calculate``,boolean,``False``,"Whether to calculate Phi K correlation"
+``correlations.phi_k.warn_high_correlations``,boolean,``False``,"Show warning for correlations higher than the threshold"
+``correlations.phi_k.threshold``,float,0.9,"Warning threshold"
+``correlations.cramers.calculate``,boolean,``False``,"Whether to calculate Cramer's V association coefficient"
+``correlations.cramers.warn_high_correlations``,boolean,``True``,"Show warning for correlations higher than the threshold"
+``correlations.cramers.threshold``,float,0.9,"Warning threshold"

4.10/advanced_settings/tables/config_general.csv

@@ -0,0 +1,4 @@
+Parameter,Type,Default,Description
+``title``,string,"Pandas Profiling Report","Title for the report, shown in the header and title bar."
+``pool_size``,integer,0,"Number of workers in thread pool. When set to zero, it is set to the number of CPUs available."
+``progress_bar``,boolean,``True``,"If ``True``, ``ydata-profiling`` will display a progress bar."

4.10/advanced_settings/tables/config_html.csv

@@ -0,0 +1,9 @@
+Parameter,Type,Default,Description
+``html.minify_html``,bool,``True``,"If ``True``, the output HTML is minified using the ``htmlmin`` package."
+``html.use_local_assets``,bool,``True``,"If ``True``, all assets (stylesheets, scripts, images) are stored locally. If ``False``, a CDN is used for some stylesheets and scripts."
+``html.inline``,boolean,``True``,"If ``True``, all assets are contained in the report. If ``False``, then a web export is created, where all assets are stored in the '[REPORT_NAME]_assets/' directory."
+``html.navbar_show``,boolean,``True``,"Whether to include a navigation bar in the report"
+``html.style.theme``,string,``None``,"Select a *bootswatch* theme. Available options: *flatly* (dark) and *united* (orange)"
+``html.style.logo``,string,"","A base64 encoded logo, to display in the navigation bar."
+``html.style.primary_color``,string,"*#337ab7*","The primary color to use in the report."
+``html.style.full_width``,boolean,``False``,"By default, the width of the report is fixed. If set to ``True``, the full width of the screen is used."

4.10/advanced_settings/tables/config_interactions.csv

@@ -0,0 +1,3 @@
+Parameter,Type,Default,Description
+``interactions.continuous``,boolean,``True``,"Generate a 2D scatter plot (or hexagonal binned plot) for all continuous variable pairs."
+``interactions.targets``,list,[],"When a list of variable names is given, only interactions between these and all other variables are computed."

4.10/advanced_settings/tables/config_missing.csv

@@ -0,0 +1,4 @@
+Parameter,Type,Default,Description
+``missing_diagrams.bar``,boolean,``True``,"Display a bar chart with counts of missing values for each column."
+``missing_diagrams.matrix``,boolean,``True``,"Display a matrix of missing values. Similar to the bar chart, but might provide overview of the co-occurrence of missing values in rows."
+``missing_diagrams.heatmap``,boolean,``True``,"Display a heatmap of missing values, that measures nullity correlation (i.e. how strongly the presence or absence of one variable affects the presence of another)."

4.10/advanced_settings/tables/config_variables.csv

@@ -0,0 +1,16 @@
+Parameter,Type,Default,Description
+``sort``,"None, asc or desc",None,"Sort the variables *asc* (ending), *desc* (ending) or *None* (leaves original sorting)."
+``variables.descriptions``,dict,{},"Ability to display a description alongside the descriptive statistics of each variable ({'var_name': 'Description'})."
+``vars.num.quantiles``,list[float],"[0.05,0.25,0.5,0.75,0.95]","The quantiles to calculate. Note that .25, .5 and .75 are required for the computation of other metrics (median and IQR)."
+``vars.num.skewness_threshold``,integer,20,"Warn if the skewness is above this threshold."
+``vars.num.low_categorical_threshold``,integer,5,"If the number of distinct values is smaller than this number, then the series is considered to be categorical. Set to 0 to disable."
+``vars.num.chi_squared_threshold``,float,0.999,"Set to 0 to disable chi-squared calculation."
+``vars.cat.length``,boolean,``True``,"Check the string length and aggregate values (min, max, mean, media)."
+``vars.cat.characters``,boolean,``False``,"Check the distribution of characters and their Unicode properties. Often informative, but may be computationally expensive."
+``vars.cat.words``,boolean,``False``,"Check the distribution of words. Often informative, but may be computationally expensive."
+``vars.cat.cardinality_threshold``,integer,50,"Warn if the number of distinct values is above this threshold."
+``vars.cat.imbalance_threshold``,float,0.5,"Warn if the imbalance score is above this threshold."
+``vars.cat.n_obs``,integer,5,"Display this number of observations."
+``vars.cat.chi_squared_threshold``,float,0.999,"Same as above, but for categorical variables."
+``vars.bool.n_obs``,integer,3,"Same as above, but for boolean variables."
+``vars.bool.imbalance_threshold``,float,0.5,"Warn if the imbalance score is above this threshold."

4.10/advanced_settings/tables/corr_matrices.csv

@@ -0,0 +1,10 @@
+Parameter,Description
+``auto``,"Calculates the column pairwise correlation depending on the type schema:
+- numerical to numerical variable: Spearman correlation coefficient
+- categorical to categorical variable: Cramer's V association coefficient 
+- numerical to categorical: Cramer's V association coefficient with the numerical variable discretized automatically "
+``spearman``,Spearman's correlation measures the strength and direction of monotonic association between two variables. Great to evaluate the strength of the relation between categorical or ordinal variables. 
+``pearson``,The Pearson correlation coefficient is the most common way of measuring a linear correlation. It is a number between –1 and 1 that measures the strength and direction of the relationship between two variables.
+``kendall``,Kendall rank correlation coefficient is a statistic used to measure the ordinal association between two measured quantities. Kendall's is often used when data doesn't meet one of the requirements of Pearson's correlation.
+``phi_k``,Phi K is especially suitable for working with mixed-type variables. Using this coefficient we can find (un)expected correlation and evaluate their statistical significance.
+``cramers``,Cramers is a correlation matrix that is commonly used to examine the association between categorical variables when there is more than 2x2 contingency.

4.10/assets/_mkdocstrings.css

@@ -0,0 +1,119 @@
+
+/* Avoid breaking parameter names, etc. in table cells. */
+.doc-contents td code {
+  word-break: normal !important;
+}
+
+/* No line break before first paragraph of descriptions. */
+.doc-md-description,
+.doc-md-description>p:first-child {
+  display: inline;
+}
+
+/* Max width for docstring sections tables. */
+.doc .md-typeset__table,
+.doc .md-typeset__table table {
+  display: table !important;
+  width: 100%;
+}
+
+.doc .md-typeset__table tr {
+  display: table-row;
+}
+
+/* Defaults in Spacy table style. */
+.doc-param-default {
+  float: right;
+}
+
+/* Backward-compatibility: docstring section titles in bold. */
+.doc-section-title {
+  font-weight: bold;
+}
+
+/* Symbols in Navigation and ToC. */
+:root,
+[data-md-color-scheme="default"] {
+  --doc-symbol-attribute-fg-color: #953800;
+  --doc-symbol-function-fg-color: #8250df;
+  --doc-symbol-method-fg-color: #8250df;
+  --doc-symbol-class-fg-color: #0550ae;
+  --doc-symbol-module-fg-color: #5cad0f;
+
+  --doc-symbol-attribute-bg-color: #9538001a;
+  --doc-symbol-function-bg-color: #8250df1a;
+  --doc-symbol-method-bg-color: #8250df1a;
+  --doc-symbol-class-bg-color: #0550ae1a;
+  --doc-symbol-module-bg-color: #5cad0f1a;
+}
+
+[data-md-color-scheme="slate"] {
+  --doc-symbol-attribute-fg-color: #ffa657;
+  --doc-symbol-function-fg-color: #d2a8ff;
+  --doc-symbol-method-fg-color: #d2a8ff;
+  --doc-symbol-class-fg-color: #79c0ff;
+  --doc-symbol-module-fg-color: #baff79;
+
+  --doc-symbol-attribute-bg-color: #ffa6571a;
+  --doc-symbol-function-bg-color: #d2a8ff1a;
+  --doc-symbol-method-bg-color: #d2a8ff1a;
+  --doc-symbol-class-bg-color: #79c0ff1a;
+  --doc-symbol-module-bg-color: #baff791a;
+}
+
+code.doc-symbol {
+  border-radius: .1rem;
+  font-size: .85em;
+  padding: 0 .3em;
+  font-weight: bold;
+}
+
+code.doc-symbol-attribute {
+  color: var(--doc-symbol-attribute-fg-color);
+  background-color: var(--doc-symbol-attribute-bg-color);
+}
+
+code.doc-symbol-attribute::after {
+  content: "attr";
+}
+
+code.doc-symbol-function {
+  color: var(--doc-symbol-function-fg-color);
+  background-color: var(--doc-symbol-function-bg-color);
+}
+
+code.doc-symbol-function::after {
+  content: "func";
+}
+
+code.doc-symbol-method {
+  color: var(--doc-symbol-method-fg-color);
+  background-color: var(--doc-symbol-method-bg-color);
+}
+
+code.doc-symbol-method::after {
+  content: "meth";
+}
+
+code.doc-symbol-class {
+  color: var(--doc-symbol-class-fg-color);
+  background-color: var(--doc-symbol-class-bg-color);
+}
+
+code.doc-symbol-class::after {
+  content: "class";
+}
+
+code.doc-symbol-module {
+  color: var(--doc-symbol-module-fg-color);
+  background-color: var(--doc-symbol-module-bg-color);
+}
+
+code.doc-symbol-module::after {
+  content: "mod";
+}
+
+.doc-signature .autorefs {
+  color: inherit;
+  border-bottom: 1px dotted currentcolor;
+}

4.10/assets/javascripts/badge.js

@@ -0,0 +1,49 @@
+const on_click_badge_name = (text) => {
+    const on_error = reason => {
+        console.error("Copying text failed:", reason);
+        iqwerty.toast.toast("Failed to copy text", options);
+    };
+    const options = {
+        style: {
+            main: {
+                // Use red as a fallback, so that I will notice (default is light blue)
+                "background": "var(--md-primary-fg-color, #2FA4E7)",
+                "color": "white",
+                "font-size": "20px",
+                "font-weight": "bold",
+            },
+        },
+        settings: {
+            duration: 1500,
+		},
+    };
+    console.log("Copying text:", text);
+    try {
+        navigator.clipboard.writeText(text).then(
+            () => iqwerty.toast.toast(`Copied "${text}"`, options)
+        ).catch(on_error);
+    } catch (error) {
+        on_error(error);
+    }
+}
+
+// This is much less likely to cause escaping issues and does not require inline scripts
+const register_badge_copy_commands = () => {
+    // console.log("badge: registering copy command handlers");
+    for (const badge of document.querySelectorAll("span[data-copy-base64]")) {
+        // console.log("badge: copy", badge);
+        const copy_base64 = badge.getAttribute("data-copy-base64");
+        if (copy_base64) {
+            const copy_ascii = atob(copy_base64);
+            const copy_uint8 = Uint8Array.from(copy_ascii, x => x.codePointAt(0));
+            const copy_unicode = new TextDecoder().decode(copy_uint8);
+            badge.addEventListener("click", () => {
+                on_click_badge_name(copy_unicode);
+            });
+        }
+    }
+}
+window.addEventListener("load", register_badge_copy_commands);
+
+// https://github.com/mlcheng/js-toast/ - MIT License - Copyright (c) 2016 Michael Cheng
+!function(t){"use strict";function n(t,r){var e=r;for(var i in t)e.hasOwnProperty(i)?null!==t[i]&&t[i].constructor===Object&&(e[i]=n(t[i],e[i])):e[i]=t[i];return e}function r(t,n){Object.keys(n).forEach((function(r){t.style[r]=n[r]}))}var e=function(){var t,e,i={SHOW:{"-webkit-transition":"opacity 400ms, -webkit-transform 400ms",transition:"opacity 400ms, transform 400ms",opacity:"1","-webkit-transform":"translateY(-100%) translateZ(0)",transform:"translateY(-100%) translateZ(0)"},HIDE:{opacity:"0","-webkit-transform":"translateY(150%) translateZ(0)",transform:"translateY(150%) translateZ(0)"}},a={style:{main:{background:"rgba(0, 0, 0, .85)","box-shadow":"0 0 10px rgba(0, 0, 0, .8)","border-radius":"3px","z-index":"99999",color:"rgba(255, 255, 255, .9)","font-family":"sans-serif",padding:"10px 15px","max-width":"60%",width:"100%","word-break":"keep-all",margin:"0 auto","text-align":"center",position:"fixed",left:"0",right:"0",bottom:"0","-webkit-transform":"translateY(150%) translateZ(0)",transform:"translateY(150%) translateZ(0)","-webkit-filter":"blur(0)",opacity:"0"}},settings:{duration:4e3}},o=[];function s(t,s,c){var l=c||i;if(void 0!==f())o.push({text:t,options:s,transitions:l});else{var m=s||{};(function(t,n,i){!function(t,n){var e=document.createElement("div");"string"==typeof t&&(t=document.createTextNode(t));e.appendChild(t),d(e),r(f(),n)}(t,n.style.main);var a=f();document.body.insertBefore(a,document.body.firstChild),a.offsetHeight,r(a,i.SHOW),clearTimeout(e),0!==n.settings.duration&&(e=setTimeout((function(){return u(i)}),n.settings.duration))})(t,m=n(a,m),l)}return{hide:function(){return u(l)}}}function u(t){var n=f();r(n,t.HIDE),clearTimeout(e),n.addEventListener("transitionend",c,{once:!0})}function c(){var t=f();if(document.body.removeChild(t),d(void 0),o.length>0){var n=o.shift();s(n.text,n.options,n.transitions)}}function f(){return t}function d(n){t=n}return{toast:s}}();t.mergeOptions=n,t.stylize=r,t.toast=e}(this.iqwerty=this.iqwerty||{});