https://github.com/microsoft/deployrUtils
Develop Portable R Code for Use with DeployR
https://github.com/microsoft/deployrUtils
Last synced: 4 months ago
JSON representation
Develop Portable R Code for Use with DeployR
- Host: GitHub
- URL: https://github.com/microsoft/deployrUtils
- Owner: microsoft
- License: mit
- Created: 2015-07-21T19:24:29.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-06-14T15:19:32.000Z (almost 2 years ago)
- Last Synced: 2024-08-13T07:13:04.719Z (8 months ago)
- Language: R
- Size: 44.9 KB
- Stars: 14
- Watchers: 12
- Forks: 14
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- jimsghstars - microsoft/deployrUtils - Develop Portable R Code for Use with DeployR (R)
README
# deployrUtils - Develop Portable R Code for Use with DeployR
[](http://nicrdepstaging.cloudapp.net:8080/job/deployrUtils/)
## Package Overview
The goal of `deployrUtils` is to solve several R portability issues that arise when developing R analytics for use in your local R environment and in the DeployR server environment. They are package portability, input portability, and portable access to data files.
These portability issues can be solved when you use the following functions in the deployrUtils package.
+ Use the `deployrPackage` function to declare your package dependencies in your R code.
+ Use the `deployrInput` function to declare the required inputs along with default values in your R code.
+ Use the `deployrExternal` function to access big data files from your R code.
## Package Installation
Get the latest stable development version from github:
```R
# Use `devtools` to install directly from github
library(devtools)
install_github("Microsoft/deployrUtils")
```
See [devtools](https://github.com/hadley/devtools) for more options.
## Usage
Install and load R packages to ensure package portability:
```R
# Use `deployrPackage()` to ensure package dependencies are installed & loaded
# at the start of your script.
> deployrPackage("ggplot2")
Loading required package: ggplot2
...
...
...
Loading required package: ggplot2
> ?ggplot2
```
Declare inputs to ensure R script input portability:
```R
# Creates a `character` variable named `char` if it does not exist
> deployrInput('{ "name": "balance", "render": "integer", "default": "500" } ')
> balance
[1] 500
```
Access big data files in a portable way across environments:
```R
## Referencing a CSV data file in your external directory
data <- read.csv(file = deployrExternal("data.csv"))
## Referencing an XDF data file in your external directory
df <- RxXdfData(deployrExternal("data.xdf"))
```
## More Information
**Issues:**
[Post an issue](https://github.com/Microsoft/deployrUtils/issues)
**Website:**
[Learn more](http://go.microsoft.com/fwlink/?LinkId=692163)
**Made by:**
Microsoft Corporation