fix: update config files to only calculate 'auto' correlation

examples/features/correlation_auto_example.py

@@ -23,15 +23,35 @@
 
 df = pd.read_csv(file_name, sep=";")
 
+# The default configuration automatically computes the 'Auto' correlation.
+# You can change the number of bins setting for this calculation as shown below.
+# This setting changes the granularity of the association measure for Numerical-Categorical column pairs.
+
 profile = ProfileReport(
-    df, title="Profile Report of the UCI Bank Marketing Dataset", explorative=True
+    df,
+    title="Profile Report of the UCI Bank Marketing Dataset",
+    config_file="src/pandas_profiling/config_default.yaml",
+    correlations={
+        "auto": {"calculate": True, "n_bins": 8},
+    },
+)
+# Saving the data profiling report with the 'auto' correlation matrix to a html file
+profile.to_file(Path("auto_uci_bank_marketing_report.html"))
+
+# The default configuration only computes the 'Auto' correlation.
+# To deactivate this setting and instead calculate other types of correlations such as Pearson's
+# and Cramer's V we can do the following:
+
+no_auto_profile = ProfileReport(
+    df,
+    title="Profile Report of the UCI Bank Marketing Dataset",
+    config_file="src/pandas_profiling/config_default.yaml",
+    correlations={
+        "auto": {"calculate": False},
+        "pearson": {"calculate": True},
+        "cramers": {"calculate": True},
+    },
 )
 
-
-# The simplest way to change the number of bins is either through your script or notebook.
-# This changes the granularity of the association measure for Numerical-Categorical column pairs.
-profile.config.correlations["auto"].n_bins = 8
-
-
-# The 'auto' correlation matrix is displayed with the other correlation matrices in the report.
-profile.to_file(Path("uci_bank_marketing_report.html"))
+# We can then save the data profiling report without the 'auto' correlation matrix to a html file
+no_auto_profile.to_file(Path("no_auto_uci_bank_marketing_report.html"))

src/pandas_profiling/config_default.yaml

@@ -90,23 +90,23 @@ missing_diagrams:
 
 correlations:
     pearson:
-      calculate: true
+      calculate: false
       warn_high_correlations: true
       threshold: 0.9
     spearman:
-      calculate: true
+      calculate: false
       warn_high_correlations: false
       threshold: 0.9
     kendall:
-      calculate: true
+      calculate: false
       warn_high_correlations: false
       threshold: 0.9
     phi_k:
-      calculate: true
+      calculate: false
       warn_high_correlations: false
       threshold: 0.9
     cramers:
-      calculate: true
+      calculate: false
       warn_high_correlations: true
       threshold: 0.9
     auto: