bf2c5383b7
This pr is auto merged as it contains a mandatory file and is opened for more than 10 days. |
||
---|---|---|
R | ||
man | ||
tests | ||
.Rbuildignore | ||
.gitignore | ||
DESCRIPTION | ||
LICENSE | ||
LICENSE.md | ||
NAMESPACE | ||
README.md | ||
SECURITY.md |
README.md
deployrUtils - Develop Portable R Code for Use with DeployR
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:
# Use `devtools` to install directly from github
library(devtools)
install_github("Microsoft/deployrUtils")
See devtools for more options.
Usage
Install and load R packages to ensure package portability:
# 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:
# 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:
## 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:
Website:
Made by:
Microsoft Corporation