Update README

YangLabHKUST · Sep 12, 2023 · 73ad468 · 73ad468
1 parent fe1f35d
commit 73ad468
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 5 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -18,6 +18,7 @@ knitr::opts_chunk$set(
 <!-- badges: start -->
 [![Codecov test coverage](https://codecov.io/gh/YangLabHKUST/mfair/branch/main/graph/badge.svg)](https://app.codecov.io/gh/YangLabHKUST/mfair?branch=main)
 [![R-CMD-check](https://github.com/YangLabHKUST/mfair/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/YangLabHKUST/mfair/actions/workflows/R-CMD-check.yaml)
+[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FYangLabHKUST%2Fmfair&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
 <!-- badges: end -->
 
 The R package `mfair` implements the methods based on the paper [MFAI: A scalable Bayesian matrix factorization approach to leveraging auxiliary information](https://doi.org/10.48550/arXiv.2303.02566).
@@ -26,14 +27,22 @@ The parameters in MAFI can be automatically determined under the empirical Bayes
 
 ## Installation
 
-You can install the development version of `mfair` from [GitHub](https://github.com/) with:
+For a quick start, you can install the development version of `mfair` from [GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("YangLabHKUST/mfair")
+```
+
+For more illustration and examples, you can alternatively use:
 
 ``` r
 # install.packages("devtools")
 devtools::install_github("YangLabHKUST/mfair", build_vignettes = TRUE)
 ```
 
-Please note that it can take several minutes to build the vignettes.
+to build vignettes simultaneously.
+Please note that it can take a few more minutes.
 
 ## Examples
 

diff --git a/README.md b/README.md
@@ -8,6 +8,7 @@
 [![Codecov test
 coverage](https://codecov.io/gh/YangLabHKUST/mfair/branch/main/graph/badge.svg)](https://app.codecov.io/gh/YangLabHKUST/mfair?branch=main)
 [![R-CMD-check](https://github.com/YangLabHKUST/mfair/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/YangLabHKUST/mfair/actions/workflows/R-CMD-check.yaml)
+[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FYangLabHKUST%2Fmfair&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
 <!-- badges: end -->
 
 The R package `mfair` implements the methods based on the paper [MFAI: A
@@ -21,15 +22,23 @@ information and immune to overfitting.
 
 ## Installation
 
-You can install the development version of `mfair` from
-[GitHub](https://github.com/) with:
+For a quick start, you can install the development version of `mfair`
+from [GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("YangLabHKUST/mfair")
+```
+
+For more illustration and examples, you can alternatively use:
 
 ``` r
 # install.packages("devtools")
 devtools::install_github("YangLabHKUST/mfair", build_vignettes = TRUE)
 ```
 
-Please note that it can take several minutes to build the vignettes.
+to build vignettes simultaneously. Please note that it can take a few
+more minutes.
 
 ## Examples