install.Rmd

---
title: Radiant -- Business analytics using R and Shiny
---

Radiant is a platform-independent browser-based interface for business analytics in [R](https://www.r-project.org/), based on the [Shiny](https://shiny.posit.co/) package. Developed by <a href="https://rady.ucsd.edu/faculty-research/faculty/vincent-nijs.html" target="_blank">Vincent Nijs</a>. Please use the issue tracker on GitHub to suggest enhancements or report problems: <a href="https://github.com/radiant-rstats/radiant/issues" target="_blank">https://github.com/radiant-rstats/radiant/issues</a>. For other questions and comments please use radiant@rady.ucsd.edu.

> **Note:** R 4.3 or higher is required to use the latest version of Radiant.

> **Note:** User profiles (or user names or logins) containing non-ASCII characters may cause problems during installation. To address this issue please use a profile name (login) that contains ASCII (A-Z, a-z) letters and numbers only. For example, c:\\users\\myprofilename

## Installing R, Rstudio, and Radiant on Windows

<!-- For Windows, download and run the all-in-one installer for <a href="https://download.rady.ucsd.edu/Rady-Radiant-Installer-Latest.exe">R, Rstudio, and Radiant</a>. If you see a warning message like the image shown below when you run the installer click on "More info" and then on "Run anyway".

<img src="images/win-protected.png" width="300px">

For a video tutorial see the `Install Radiant on Windows` video below:

<iframe width="640" height="375" src="https://www.youtube.com/embed/ZNgwgosdNhM" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

> Credits: Thanks go to Brandon Salas (Rady School of Management @ UCSD) for creating the Windows installer and Greg Aujero (Rady School of Management @ UCSD) for updating the installer.
 -->

To install R, Rstudio, and Radiant on Windows copy-and-paste the command below into Powershell and press the return key.

```bash
iwr -useb https://raw.githubusercontent.com/vnijs/radiant_install/main/windows-install-radiant.ps1 | iex
```

This script will install the latest versions of R, Rstudio, and Radiant-for-R. To run Radiant, open Rstudio and select "Start radiant (browser)" from the _Addins_ menu. If you don't see "Start radiant (browser)" in Rstudio you can try restarting Rstudio or running "radiant::radiant()" in the console in Rstudio (i.e., the window on the bottom-left in Rstudio). For a step-by-step demo of the install process, see the video below.

<iframe width="640" height="360" src="https://www.youtube.com/embed/y5s3JBD23Vw" title="Installing radiant on Windows" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

## Installing R, Rstudio, and Radiant on macOS

To install R, Rstudio, and Radiant on macOS copy-and-paste the command below into the Terminal application and press the return key.

```bash
curl -fsSL https://raw.githubusercontent.com/vnijs/radiant_install/refs/heads/main/macos-install-radiant.sh | bash
```

This script will install the latest versions of R, Rstudio, and Radiant-for-R. To run Radiant, open Rstudio and select "Start radiant (browser)" from the _Addins_ menu. If you don't see "Start radiant (browser)" in Rstudio you can try restarting Rstudio or running "radiant::radiant()" in the console in Rstudio (i.e., the window on the bottom-left in Rstudio). For a step-by-step demo of the install process, see the video below.

<iframe width="640px" height="360px" src="https://www.youtube.com/embed/h-aVNpI8b1E" title="Installing radiant on macOS" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

<!-- ## Installing R, Rstudio, and Radiant on Linux

The first step will be to install R and a several additional linux tools. The commands required for Ubuntu 18.04 are shown below:

```sh
sudo apt-get update
sudo apt-get install gpg-agent gdebi-core

## Appends the CRAN repository to your sources.list file
sudo sh -c "echo 'deb http://cloud.r-project.org/bin/linux/ubuntu focal-cran40/' >> /etc/apt/sources.list"
sudo gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys E298A3A825C0D65DFD57CBB651716619E084DAB9
sudo gpg -a --export E298A3A825C0D65DFD57CBB651716619E084DAB9 | apt-key add -
sudo apt-get update

## Install R and required linux tools
sudo apt-get install r-base r-base-dev
sudo apt-get install libssl-dev libcurl4-openssl-dev libxml2-dev libicu-dev \
  unixodbc-dev libpq-dev libgdal-dev libproj-dev libcairo2-dev cargo libgsl-dev

## Download and install Rstudio (preview)
wget -O rstudio-amd64.deb https://download1.rstudio.org/desktop/bionic/amd64/rstudio-2022.02.2-485-amd64.deb
sudo gdebi rstudio-amd64.deb
rm rstudio-amd64.deb
```

Run the following command to install the required R-packages for a user:

```r
R -e "source('https://raw.githubusercontent.com/radiant-rstats/minicran/gh-pages/update.R')"
```

To make R-packages available to all users on a linux system run the command below instead:

```r
sudo su -c "R -e \"source('https://raw.githubusercontent.com/radiant-rstats/minicran/gh-pages/update.R')\""
```

To ensure that all packages are available and up to date use:

```r
R -e "radiant.update::radiant.update()"
```

or

```r
sudo su -c "R -e 'radiant.update::radiant.update()'"
``` -->

## Starting and Stopping

We recommend you use Rstudio to run the Radiant application. When you open Rstudio you can start Radiant through the `Addins` menu at the top of the screen `Start radiant (browser)`. If for some reason the `Start radiant (browser)` is not shown in the dropdown, enter `radiant::radiant()` in the Rstudio console. To close the application click the <i title='Power off' class='fa fa-power-off'></i> icon in the navigation bar and then click `Stop`. The Radiant process will stop and the browser window will close or gray-out.

<!--
To add an option to upgrade Radiant easily, use the commands below to install the `radiant.upgrade` package. You should now see two new item in the `Addins` dropdown that you can use for future radiant upgrades.

```r
options(repos = c(RSM = "https://radiant-rstats.github.io/minicran", CRAN = "https://cloud.r-project.org"))
install.packages("remotes")
remotes::install_github("radiant-rstats/radiant.update", upgrade = "never")
radiant.update::radiant.update()
```
-->

## Sharing Rstudio projects with others

An excellent way to share an Rstudio project hosted online (e.g., on Dropbox) with others is to use the `usethis` package

```r
install.packages("usethis")
?usethis::use_course
```

As an example, run the command below to download and open an Rstudio project. Note the "1" at the end of the URL instead of Dropbox's default which is "0".

```r
usethis::use_course("https://www.dropbox.com/sh/0dmcr2xsphtn1ha/AADsrYsi8KBkddWx_B-aQbi1a?dl=1")
```

## Documentation

Documentation and tutorials for each of the apps are available at <https://radiant-rstats.github.io/docs/> and in the Radiant web interface (the <i title='Help' class='fa fa-edit'></i> icons on each page and the <i title='Help' class='fa fa-question-circle'></i> icon in the navigation bar). See also the [pkgdown](https://github.com/r-lib/pkgdown) documentation sites:

* http://radiant-rstats.github.io/radiant
* http://radiant-rstats.github.io/radiant.data
* http://radiant-rstats.github.io/radiant.design
* http://radiant-rstats.github.io/radiant.basics
* http://radiant-rstats.github.io/radiant.model
* http://radiant-rstats.github.io/radiant.multivariate

Want more help getting started? Watch the tutorials on the [documentation site](https://radiant-rstats.github.io/docs/tutorials.html).

## Trouble shooting

Windows users may need to start R and Rstudio `as administrator`. On rare occasions R(studio) may complain that a package is not yet installed when starting Radiant. If so, install the package mentioned using the command below but replace 'package-that-is-not-yet-installed' with the package name mentioned in the error message

```r
install.packages("package-that-is-not-yet-installed", repos = "https://cran.rstudio.com", type = "binary")
```

Some users have reported that the Malwarebytes software can inappropriately block R-packages from being installed or updated. If you use Malwarebytes and are experiencing problems you can try (temporarily) turning it off during the install process or when upgrading.

If there is an error installing `tinytex` on macOS please run the command below from the "terminal" app:

```bash
sudo chown -R $(whoami):admin /usr/local/bin; R -e "tinytex::install_tinytex()"
```

## Reporting issues

Rady students can report any issues they might have with Radiant on Piazza. Otherwise, please use the GitHub issue tracker at <a href="https://github.com/radiant-rstats/radiant/issues" target="_blank">github.com/radiant-rstats/radiant/issues</a>.