You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/quick-start.mdx
+21-16Lines changed: 21 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,50 +10,55 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
10
10
11
11
It is necessary to have the [**R 4.0.0 version (or higher)**](https://www.r-project.org/) installed in order to be able to run this code. R is a free software environment for statistical computing and graphics. It compiles and runs on a wide variety of UNIX platforms, Windows and MacOS. To
12
12
[download R.](https://cran.r-project.org/mirrors.html), please choose your
13
-
preferred [CRAN mirror.](https://cran.r-project.org/mirrors.html). **Please make sure you have restarted your R session once you have installed the latest R version.**
13
+
preferred [CRAN mirror](https://cran.r-project.org/mirrors.html). **Please make sure you have restarted your R session once you have installed the latest R version.**
14
+
15
+
**Optional (and recommended)**: after you've installed R, you may install [RStudio IDE](https://www.rstudio.com/products/rstudio/download/) for a better and smoother experience. RStudio IDE is a set of integrated tools designed to help you be more productive with R and Python. It includes a console, syntax-highlighting editor that supports direct code execution, and a variety of robust tools for plotting, viewing history, debugging and managing your workspace.
14
16
15
17
---
16
18
## 2. Installing the package
17
19
18
-
Please run `remotes::install_github("facebookexperimental/Robyn/R")` to install the package. If you haven't installed the `remotes` package previously, run `install.packages('remotes')`first.
20
+
To install or update Robyn to the latest stable version of the package, run:
21
+
```
22
+
install.packages("Robyn")
23
+
```
19
24
20
-
Robyn requires the Python library [Nevergrad](https://facebookresearch.github.io/nevergrad/).
21
-
You must install it once for the code to work properly.
22
-
Please find [here](https://rstudio.github.io/reticulate/articles/python_packages.html) more info about installing Python packages via reticulate.
25
+
**NOTE**: If you're interested in installing the latest or a specific **dev version** instead, run `remotes::install_github("facebookexperimental/Robyn/R")`. If you haven't installed the `remotes` package previously, run `install.packages('remotes')` first.
23
26
24
-
1. First step is to install the [reticulate package](https://rstudio.github.io/reticulate/) via the following command: `install.packages(‘reticulate’)`
25
-
2. Load the package using: `library(reticulate)`
26
-
3. Install nevergrad. You have 2 options:
27
+
Robyn also requires the Python library [Nevergrad](https://facebookresearch.github.io/nevergrad/).
28
+
**You must install it once for the code to work properly**. Please find [here](https://rstudio.github.io/reticulate/articles/python_packages.html) more info about installing Python packages via reticulate.
27
29
30
+
1. First step is to install the [reticulate package](https://rstudio.github.io/reticulate/) (if you haven't before) and load it:
31
+
```
32
+
install.packages("reticulate")
33
+
library(reticulate)
34
+
```
35
+
2. Install `nevergrad` Python library. You have 2 options:
28
36
29
-
-**Option 1: nevergrad installation via PIP**
37
+
-**Option 1: using PIP**
30
38
31
39
```
32
40
virtualenv_create("r-reticulate")
33
41
py_install("nevergrad", pip = TRUE)
34
42
use_virtualenv("r-reticulate", required = TRUE)
35
43
```
36
44
37
-
-**Option 2: nevergrad installation via conda**
45
+
-**Option 2: using conda**
38
46
39
47
```
40
-
conda_create("r-reticulate") # must run this line once
If it's taking too long to download, you have a slow or unstable internet connection, and have issues while installing the package, try setting `options(timeout=400)`
46
-
47
53
In case nevergrad still cannot be imported after installation, please locate your python file and run this line using your path:
For Windows, if you get openssl error, please see instructions [here](https://stackoverflow.com/questions/54558389/how-to-solve-this-error-while-installing-python-packages-in-rstudio/54566647) and [here](https://dev.to/danilovieira/installing-openssl-on-windows-and-adding-to-path-3mbf) to install and update openssl.
52
57
53
58
---
54
59
## 3. Getting started with the [demo.R](https://github.com/facebookexperimental/Robyn/blob/main/demo/demo.R) script
55
60
56
-
Open the [demo.R](https://github.com/facebookexperimental/Robyn/blob/main/demo/demo.R) script in the inst folder as a quick start guide that aims to cover most common use-cases.
61
+
Open the [demo.R](https://github.com/facebookexperimental/Robyn/blob/main/demo/demo.R) script in the `inst` folder as a quick start guide that aims to cover most common use-cases.
57
62
The demo will allow you to test the package using a simulated dataset.
0 commit comments