feat(eda.report): allow disabling the progress bar

dataprep/eda/create_report/__init__.py

@@ -21,6 +21,7 @@ def create_report(
     df: pd.DataFrame,
     title: Optional[str] = "DataPrep Report",
     mode: Optional[str] = "basic",
+    progress: bool = True,
 ) -> Report:
     """
     This function is to generate and render element in a report object.
@@ -34,6 +35,8 @@ def create_report(
     mode: Optional[str], default "basic"
         This controls what type of report to be generated.
         Currently only the 'basic' is fully implemented.
+    progress
+        Whether to show the progress bar.
 
     Examples
     --------
@@ -48,7 +51,7 @@ def create_report(
     context = {
         "resources": INLINE.render(),
         "title": title,
-        "components": format_report(df, mode),
+        "components": format_report(df, mode, progress),
     }
     template_base = ENV_LOADER.get_template("base.html")
     report = template_base.render(context=context)

dataprep/eda/create_report/formatter.py

@@ -33,7 +33,7 @@
 
 
 def format_report(
-    df: Union[pd.DataFrame, dd.DataFrame], mode: Optional[str]
+    df: Union[pd.DataFrame, dd.DataFrame], mode: Optional[str], progress: bool = True
 ) -> Dict[str, Any]:
     """
     Format the data and figures needed by report
@@ -42,9 +42,11 @@ def format_report(
     ----------
     df
         The DataFrame for which data are calculated.
-    mode: Optional[str]
+    mode
         This controls what type of report to be generated.
         Currently only the 'basic' is fully implemented.
+    progress
+        Whether to show the progress bar.
 
     Returns
     -------
@@ -53,7 +55,7 @@ def format_report(
         This variable acts like an API in passing data to the template engine.
     """
     # pylint: disable=too-many-locals,too-many-statements
-    with ProgressBar(minimum=1):
+    with ProgressBar(minimum=1, disable=not progress):
         df = to_dask(df)
         if mode == "basic":
             comps = format_basic(df)