RCloud powered dashboards and websites
JavaScript CSS Smarty R HTML Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github corrected filename typo Jun 23, 2017
R
inst fixes #307 Apr 10, 2018
man Move files around to put R in charge Aug 11, 2016
tests Move files around to put R in charge Aug 11, 2016
.Rbuildignore
.gitignore
DESCRIPTION
LICENSE Update LICENSE Sep 7, 2017
NAMESPACE Use correct function in rcap.progressSpinner.msg Jan 9, 2018
README.md youtube video screenshot and link, rewording Apr 24, 2018
app.Rproj Move files around to put R in charge Aug 11, 2016
mkdist
youtube.png youtube video screenshot for readme Apr 24, 2018

README.md

RCAP

Introduction

RCAP is an Interactive Dashboard Builder extension for RCloud. An RCAP dashboard is an RCloud asset associated with an RCloud notebook. Use RCAP to create and edit the dashboard, and rcap.html mode to view and share it.

RCAP Example on YouTube

Building

Build has the following environment dependencies:

  • node.js & npm, bower,
  • grunt and GNU make.

To build RCAP package run the following command from package source:

git clone https://github.com/att/rcloud.rcap
cd rcloud.rcap
sh ./mkdist

The 'mkdist' script accepts a number of optional parameters useful during development:

 Usage: ./mkdist [{--no-npm | --no-js | --no-clean > | --help}] [install]
 --no-clean - skips clean phase
 --no-npm - skips npm processing step (implies --no-clean option)
 --no-js - skips entire JavaScript processing step (implies --no-npm option)
 --help - displays usage information

 --install - should package be installed after it has been built.

Installation

RCAP bundle

It is possible to install RCAP from R package bundle, which contains all JS dependencies.

wget 'https://github.com/att/rcloud.rcap/releases/download/0.4/rcloud.rcap_0.4.7.1.tar.gz'
R CMD INSTALL rcloud.rcap_0.4.7.1.tar.gz

devtools

To install the latest released build, you can use the devtools package:

devtools::install_url(
  "https://github.com/att/rcloud.rcap/releases/download/0.4/rcloud.rcap_0.4.7.1.tar.gz"
)

You can also run this from within an RCloud notebook, assuming you have access rights to install R packages on the RCloud server.

To install the development version, use

devtools::install_github("att/rcloud.rcap@develop", local = FALSE)

Configuration

After installing the R package, you can enable RCAP in RCloud in the Settings menu (on the bottom left). Add rcloud.rcap to the Enable Extensions line, and reload the notebook.

You can start the designer from the Advanced menu.

License

MIT @ AT&T