From 407b0be41f43bce4c8e9000c4058d0dea63300d8 Mon Sep 17 00:00:00 2001
From: changwoo-lee <c.lee@tamu.edu>
Date: Fri, 29 Dec 2023 00:47:04 -0600
Subject: [PATCH] readme update

---
 README.Rmd | 21 ++++++++++++++++++---
 README.md  | 18 +++++++++++++++++-
 2 files changed, 35 insertions(+), 4 deletions(-)

diff --git a/README.Rmd b/README.Rmd
index 24f414b..436f50f 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -20,9 +20,9 @@ knitr::opts_chunk$set(
 # bspme 
 <!-- badges: start -->
 <!-- badges: end -->
-Go to package website: [[link]](https://changwoo-lee.github.io/bspme/)
+Go to package website: [[link]](https://changwoo-lee.github.io/bspme/) (NOTE: IT IS NOW UNPUBLISHED)
 
-See a vignette with ozone exposure data: [[link]](https://changwoo-lee.github.io/bspme/articles/Ozone-exposure-and-health-data-analysis.html)
+See a vignette with ozone exposure data: [[link]](https://changwoo-lee.github.io/bspme/articles/Ozone-exposure-and-health-data-analysis.html) (NOTE: SEE BELOW "INSTALLATION" SECTION INSTEAD)
 
 **bspme** is an R package that provides a set of functions for **B**ayesian **sp**atially correlated **m**easurement **e**rror models, the Bayesian linear models with the presence of (spatially) correlated measurement error of covariate(s). For more details, please see the following paper:
 
@@ -56,7 +56,14 @@ You can install the development version of bspme with the following code:
 
 ``` r
 # install.packages("devtools")
-devtools::install_github("changwoo-lee/bspme")
+# never share below token
+devtools::install_github("changwoo-lee/bspme", auth_token = "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", build_vignettes = T, force= T)
+```
+
+To browse and see vignettes, run
+
+``` r
+browseVignettes("bspme")
 ```
 
 
@@ -69,6 +76,14 @@ devtools::install_github("changwoo-lee/bspme")
 | `vecchia_cov()`       | Perform the Vecchia approximation given a MVN covariance matrix               |
 
 
+To see function description in R environment, run the following lines:
+
+
+``` r
+?blinreg_me
+?vecchia_cov
+```
+
 
 ## datasets
 
diff --git a/README.md b/README.md
index 7fe8297..27a31f3 100644
--- a/README.md
+++ b/README.md
@@ -7,9 +7,11 @@
 <!-- badges: end -->
 
 Go to package website: [\[link\]](https://changwoo-lee.github.io/bspme/)
+(NOTE: IT IS NOW UNPUBLISHED)
 
 See a vignette with ozone exposure data:
 [\[link\]](https://changwoo-lee.github.io/bspme/articles/Ozone-exposure-and-health-data-analysis.html)
+(NOTE: SEE BELOW “INSTALLATION” SECTION INSTEAD)
 
 **bspme** is an R package that provides a set of functions for
 **B**ayesian **sp**atially correlated **m**easurement **e**rror models,
@@ -69,7 +71,14 @@ code:
 
 ``` r
 # install.packages("devtools")
-devtools::install_github("changwoo-lee/bspme")
+# never share below token
+devtools::install_github("changwoo-lee/bspme", auth_token = "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", build_vignettes = T, force= T)
+```
+
+To browse and see vignettes, run
+
+``` r
+browseVignettes("bspme")
 ```
 
 ## Functionality
@@ -80,6 +89,13 @@ devtools::install_github("changwoo-lee/bspme")
 | `blogireg_me()` | Bayesian logistic regression models with a MVN prior for measurement errors      |
 | `vecchia_cov()` | Perform the Vecchia approximation given a MVN covariance matrix                  |
 
+To see function description in R environment, run the following lines:
+
+``` r
+?blinreg_me
+?vecchia_cov
+```
+
 ## datasets
 
 | Dataset call         | Description                                                |