docs: explain installation method better

This commit is contained in:
Martin Chan 2020-11-17 22:30:32 +00:00 коммит произвёл GitHub
Родитель 0fab654ac8
Коммит e11873322d
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 4 добавлений и 2 удалений

Просмотреть файл

@ -31,9 +31,9 @@ Here are just some examples of the plots that you can create with **wpa**:
## :rocket: Quick start guide - For users
### Installing the package from GitHub
### Installing the package
You can install **wpa** from GitHub with the following:
You can install the GitHub version of **wpa** with the following in R:
```R
# Check if devtools is installed, if not then install it
if(!"devtools" %in% installed.packages()){
@ -41,6 +41,8 @@ if(!"devtools" %in% installed.packages()){
}
devtools::install_git(url = "https://github.com/microsoft/wpa.git")
```
Note that **wpa** is not yet released on CRAN, and therefore `install.packages()` will not work.
### Examples
The package comes shipped with a sample Standard Query dataset (`sq_data`), so you can start exploring functions without having to read in any data. Most functions in **wpa** share a consistent API, and enable you to return results for both a **plot** or a **table** (data frame):