Added instructions for progressr

README.Rmd

@@ -43,21 +43,30 @@ You can obtain direct help for any of the package's user-facing functions with t
 
 You can obtain the official releases from [CRAN](https://CRAN.R-project.org/package=ale):
 
-```{r, eval = FALSE}
+```{r install on CRAN, eval = FALSE}
 install.packages('ale)
 ```
 
 The CRAN releases are extensively tested and should have relatively few bugs. However, note that this package is still in beta stage. For the `{ale}` package, that means that there will occasionally be new features with changes in the function interface that might break the functionality of earlier versions. Please excuse us for this as we move towards a stable version that flexibly meets the needs of the broadest user base.
 
 To get the most recent features, you can install the development version of ale from [GitHub](https://github.com/Tripartio/ale) with:
 
-```{r, eval = FALSE}
+```{r install dev version, eval = FALSE}
 # install.packages("pak")
 pak::pak("Tripartio/ale")
 ```
 
 The development version in the main branch of GitHub is always thoroughly checked. However, the documentation might not be fully up-to-date with the functionality.
 
+There is one more optional but recommended setup option. To enable **progress bars** to see how long procedures will take, you should run the following code at the beginning of your R session:
+
+```{r enable progressr, eval = FALSE}
+progressr::handlers(global = TRUE)
+progressr::handlers('cli')
+```
+
+The `{ale}` package will normally run this automatically for you the first time you execute a function from the package in an R session. To see how to configure this permanently, see [help(ale)].
+
 ## Usage
 
 Here is a simple example that demonstrates the usage of the model. First, we train a GAM model. Then, with a test dataset and a model object, we can create ALE data with the `ale()` function and then plot the `ggplot` plot objects.

README.md

@@ -85,6 +85,19 @@ The development version in the main branch of GitHub is always
 thoroughly checked. However, the documentation might not be fully
 up-to-date with the functionality.
 
+There is one more optional but recommended setup option. To enable
+**progress bars** to see how long procedures will take, you should run
+the following code at the beginning of your R session:
+
+``` r
+progressr::handlers(global = TRUE)
+progressr::handlers('cli')
+```
+
+The `{ale}` package will normally run this automatically for you the
+first time you execute a function from the package in an R session. To
+see how to configure this permanently, see \[help(ale)\].
+
 ## Usage
 
 Here is a simple example that demonstrates the usage of the model.