Skip to content
Business analytics using R and Shiny http://vnijs.github.io/radiant/
HTML R JavaScript Other
Find file

README.md

Radiant - Business analytics using R and Shiny

Travis-CI Build Status

Radiant is a platform-independent browser-based interface for business analytics in R, based on the Shiny package. Developed by Vincent Nijs. Please use the issue tracker on GitHub to suggest enhancements or report problems: https://github.com/vnijs/radiant/issues. For other questions and comments please use radiant@rady.ucsd.edu.

Key features

  • Explore: Quickly and easily summarize, visualize, and analyze your data
  • Cross-platform: It runs in a browser on Windows, Mac, and Linux
  • Reproducible: Recreate results and share work with others as a state file or an Rmarkdown report
  • Programming: Integrate Radiant's analysis functions into your own R-code
  • Context: Data and examples focus on business applications

Explore

Radiant is interactive. Results update immediately when inputs are changed (i.e., no separate dialog boxes). This greatly facilitates exploration and understanding of the data.

Cross-platform

Radiant works on Windows, Mac, or Linux. It can run without an Internet connection and no data will leave your computer. You can also run the app as a web application on a server.

Note: For Windows users with data that contain multibyte characters please make sure your data are in ANSI format so R(adiant) can load characters correctly.

Reproducible

Simply saving output is not enough. You need the ability to recreate results for the same data and/or when new data become available. Moreover, others may want to review your analysis and results. Save and load the state of the application to continue your work at a later time or on another computer. Share state files with others and create reproducible reports using Rmarkdown. See also the section on Saving and loading state below

If you are using Radiant on a server you can even share the url (include the SSUID) with others so they can see what you are working on. Thanks for this feature go to Joe Cheng.

Programming

Although Radiant's web-interface can handle quite a few data and analysis tasks, at times you may prefer to write your own code. Radiant provides a bridge to programming in R(studio) by exporting the functions used for analysis. For more information about programming with Radiant see the programming page on the documentation site.

Context

Radiant focuses on business data and decisions. It offers tools, examples, and documentation relevant for that context, effectively reducing the business analytics learning curve.

How to install Radiant

  • Required: R version 3.2 or later
  • Required: A modern browser (e.g., Chrome or Safari). Internet Explorer (version 11 or higher) should work as well
  • Recommended: Rstudio

To install the latest version for Windows of Mac with complete documentation for off-line access open R(studio) and copy-and-paste the command below:

install.packages("radiant", repos = "http://vnijs.github.io/radiant_miniCRAN/", type = 'binary')

Once all packages are installed use the command below to launch the app (use either "base", "quant", "marketing" or "analytics"):

radiant::radiant("analytics")

See the installing radiant page for more details.

You can create a launcher on your Desktop to start Radiant by typing radiant::launcher("analytics") in the R(studio) console and pressing return. Again, enter either "base", "quant", "marketing" or "analytics" depending on the app you want to use. A file called radiant.bat (windows) or radiant.command (mac) will be created that you can double-click to start Radiant in your default browser. The launcher command will also create a file called update_radiant.bat (windows) or update_radiant.command (mac) that you can double-click to update Radiant to the latest release.

When Radiant starts you will see data on diamond prices. To close the application click the icon in the navigation bar and then click Stop. The Radiant process will stop and the browser window will close (Chrome) or gray-out.

Documentation

Documentation and tutorials are available at http://vnijs.github.io/radiant/ and in the Radiant web interface (the icons on each page and the icon in the navigation bar).

Want some help getting started? Watch the tutorials on the documentation site.

Reporting issues

Please use the GitHub issue tracker at github.com/vnijs/radiant/issues if you have any problems with Radiant.

Online

Not ready to install Radiant on your computer? Try it online at the links below:

vnijs.shinyapps.io/analytics

vnijs.shinyapps.io/marketing

vnijs.shinyapps.io/quant

vnijs.shinyapps.io/base

Running Radiant on shinyapps.io / shiny-server

You can run Radiant on shinyapps.io or a (linux) server supported by Shiny server.

To run your own server instance copy/fork the repo from github and deploy to shinyapps.io as usual. Shinyapps.io may complain about paths but you shouldn’t have any trouble if you know how to deploy to shinyapps.io. If you do run into difficulties, also clone the repo at https://github.com/vnijs/shinyapps and run the deploy2shinyapp.R file in the Radiant/build folder.

You can also host Radiant using shiny-server. Just point shiny-server to the directory in inst/ you want to use. As a courtesy, please let me know if you intend to use Radiant on a server.

Saving and loading state

To save your analyses save the state of the app to a file by clicking on the icon in the navbar and then on Save state (see also the Data > Manage tab). You can open this state file at a later time or on another computer to continue where you left off. You can also share the file with others that may want to replicate your analyses. As an example, load the state_file radiant-state.rda through the Data > Manage tab. Go to Data > View, Data > Visualize to see some of the settings. There is also a report in R > Report that was created using the Radiant interface. The html file radiant-state.html contains the output.

A related feature in Radiant is that state is maintained if you accidentally navigate to another page, close (and reopen) the browser, and/or hit refresh. Use Reset in the menu in the navigation bar to return to a clean/new state.

Loading and saving state also works with Rstudio. If you start Radiant from Rstudio and use > Stop to stop the app, lists called r_data and r_state will be put into Rstudio's global workspace. If you start radiant again using radiant() it will use these lists to restore state. This can be convenient if you want to make changes to a data file in Rstudio and load it back into Radiant. Also, if you load a state file directly into Rstudio it will be used when you start Radiant to recreate a previous state.

Technical note: The way loading state works in Radiant is as follows: When an input is initialized in a Shiny app you set a default value in the call to, for example, numericInput. In Radiant, when a state file has been loaded and an input is initialized it looks to see if there is a value for an input of that name in a list called r_state. If there is, this value is used. The r_state list is created when saving state using reactiveValuesToList(input). An example of a call to numericInput is given below where the state_init function from radiant.R is used to check if a value from r_state can be used. sm_args$comp_value is the default value specified in the single_mean function call.

numericInput("sm_comp_value", "Comparison value:", state_init('sm_comp_value',sm_args$comp_value))

Source code

The source code is available on GitHub at https://github.com/vnijs/radiant. Three (related) apps are included in the inst/ directory. Base, offers data loading, saving, viewing, visualizing, merging, and transforming tools. The quant app sources the code from base and extends it. This app is used in the Quantitative Analysis class at the Rady School of Management (UCSD). Finally, the marketing app sources the code from base and quant and extends it with additional tools. The quant app focuses on (basic) quantitative analysis (e.g., comparing means, regression, etc.). The marketing app focuses on marketing analytics by adding clustering, principle component analysis, conjoint analysis, etc. This app is used in the Research for Marketing Decisions class at Rady (UCSD).

Credits

Radiant would not be possible without R and Shiny. I would like to thank Joe Cheng, Winston Chang, and Yihui Xie for answering questions, providing suggestions, and creating amazing tools for the R community. Other key components used in Radiant are ggplot2, dplyr, tidyr, magrittr, broom, shinyAce, knitr, and DT. For an overview of other packages that Radiant relies on please see the about page.

License

Radiant is licensed under the AGPLv3. The documentation and videos on this site and the radiant help files are licensed under the creative commons attribution, non-commercial, share-alike license CC-NC-SA.

As a summary, the AGPLv3 license requires, attribution, including copyright and license information in copies of the software, stating changes if the code is modified, and disclosure of all source code. Details are in the COPYING file.

If you are interested in using Radiant please email me at radiant@rady.ucsd.edu

© Vincent Nijs (2015) Creative Commons License

Something went wrong with that request. Please try again.