Name: rallyengine
Description: R package driving parsing and production of rally inputs and outputs
Created: 2017-09-06 07:48:00.0
Updated: 2017-11-13 20:46:01.0
Pushed: 2017-11-18 00:40:43.0
Homepage: null
Size: 486
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
This R package acts as an engine for parsing HBGDki rally master templates and generating rally outputs.
This is a package that will not be of use to the general public. It's hosted publicly to make it easy to install and work on.
You can install rallyengine from github with:
stall.packages("devtools")
ools::install_github("HBGDki/rallyengine")
This package provides many functions for parsing rally master templates and generating outputs and provides a REST API for accessing these outputs. It also provides a self-contained web front-end that consumes these APIs to provide rally dashboard, overview, and admin pages.
The REST API is pretty straightforward and can be followed by looking here: https://github.com/HBGDki/rallyengine/blob/master/inst/api/
This directory also contains a Dockerfile for setting up the REST API and commands to run it.
The web front-end pages are here: https://github.com/HBGDki/rallyengine/tree/master/inst/www
Beyond building the Dockerfile, the only other setup necessary to get a working environment is to set the following environment variables:
PAT=__Open Science Framework personal access token__
Y_BASE_PATH=__path to where web files and content cache will be stored__
Y_API_SERVER=__url of location from which API is served__