Update README to address locked binding

Signed-off-by: milevavantuyl <[email protected]>
Trusted-AI · Jun 1, 2022 · 60cdda8 · 60cdda8
1 parent 9eae520
commit 60cdda8
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 20 deletions.
diff --git a/aif360/aif360-r/README.Rmd b/aif360/aif360-r/README.Rmd
@@ -116,6 +116,8 @@ load_aif360_lib()
 load_aif360_lib()
 ```
 
+If you get an error: `cannot change value of locked binding`, please restart the R session and run `load_aif360_lib()` exactly once.
+
 ``` r
 # load a toy dataset
 data <- data.frame("feature1" = c(0,0,1,1,1,1,0,1,1,0),

diff --git a/aif360/aif360-r/README.md b/aif360/aif360-r/README.md
@@ -5,7 +5,7 @@
 
 <!-- badges: start -->
 
-[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/aif360)](https://cran.r-project.org/package=aif360)
+[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/aif360)](https://cran.r-project.org/package=aif360)
 <!-- badges: end -->
 
 ## Overview
@@ -31,7 +31,7 @@ Or install the development version from GitHub:
 devtools::install_github("Trusted-AI/AIF360/aif360/aif360-r")
 ```
 
-Then, use the install\_aif360() function to install AIF360:
+Then, use the install_aif360() function to install AIF360:
 
 ``` r
 library(aif360)
@@ -42,7 +42,7 @@ install_aif360()
 
 AIF360 is distributed as a Python package and so needs to be installed
 within a Python environment on your system. By default, the
-install\_aif360() function attempts to install AIF360 within an isolated
+install_aif360() function attempts to install AIF360 within an isolated
 Python environment (“r-reticulate”).
 
 You can check using `reticulate::conda_python()` and
@@ -53,42 +53,36 @@ You can check using `reticulate::conda_python()` and
 1)  Install reticulate and check if you have miniconda installed. If you
     do, go to step 2.
 
-<!-- end list -->
-
 ``` r
 install.packages("reticulate")
 reticulate::conda_list()
 ```
 
-If you get an error: `Error: Unable to find conda binary. Is Anaconda
-installed?`, please install miniconda
+If you get an error:
+`Error: Unable to find conda binary. Is Anaconda installed?`, please
+install miniconda
 
 ``` r
 reticulate::install_miniconda()
 ```
 
 If everything worked, you should get the message:
 
-`* Miniconda has been successfully installed at
-'/home/rstudio/.local/share/r-miniconda'.`
+`* Miniconda has been successfully installed at '/home/rstudio/.local/share/r-miniconda'.`
 
 You can double check:
 
     reticulate::conda_list()
 
 You will get something like this:
 
-``` 
-          name                                                              python
-1  r-miniconda                   /home/rstudio/.local/share/r-miniconda/bin/python
-2 r-reticulate /home/rstudio/.local/share/r-miniconda/envs/r-reticulate/bin/python
-```
+              name                                                              python
+    1  r-miniconda                   /home/rstudio/.local/share/r-miniconda/bin/python
+    2 r-reticulate /home/rstudio/.local/share/r-miniconda/envs/r-reticulate/bin/python
 
 2)  You can create a new conda env and then configure which version of
     Python to use:
 
-<!-- end list -->
-
 ``` r
 reticulate::conda_create(envname = "r-test")
 reticulate::use_miniconda(condaenv = "r-test", required = TRUE)
@@ -99,8 +93,6 @@ Check that everything is working `reticulate::py_config()`.
 3)  If you haven’t yet, please install the aif360 package
     `install.packages("aif360")` and then install aif360 dependencies
 
-<!-- end list -->
-
 ``` r
 aif360::install_aif360(envname = "r-test")
 ```
@@ -110,7 +102,7 @@ restart.
 
 4)  Finally, load the aif360 functions
 
-<!-- end list -->
+<!-- -->
 
     library(aif360)
     reticulate::use_miniconda(condaenv = "r-test", required = TRUE)
@@ -122,11 +114,14 @@ restart.
 load_aif360_lib()
 ```
 
+If you get an error: `cannot change value of locked binding`, please
+restart the R session and run `load_aif360_lib()` exactly once.
+
 ``` r
 # load a toy dataset
 data <- data.frame("feature1" = c(0,0,1,1,1,1,0,1,1,0),
                    "feature2" = c(0,1,0,1,1,0,0,0,0,1),
-                  "label" = c(1,0,0,1,0,0,1,0,1,1))
+                   "label" = c(1,0,0,1,0,0,1,0,1,1))
 
 # format the dataset
 formatted_dataset <- aif360::aif_dataset(data_path = data,