Domino Data Lab R console bindings

Description

The Domino R package is a wrapper on top of the Domino command-line client. It lets you run Domino commands (e.g., "run", "upload", "download") directly from your R environment. Under the hood, it uses R's system function to run the Domino executable, which must be installed as a prerequisite.

Details

Package: domino
Type: Package
Version: 0.2-7
Date: 2015-05-27
License: MIT
Author: Jacek Glodek jacek@theiterators.com
Maintainer: Nick Elprin nick@dominoup.com

References

Domino Data Lab support webpage - http://help.dominodatalab.com/

Examples

## Not run: 
## logins as a given user to the Domino server
## and approves sending error reports to Domino.
domino.login("jglodek", "MySecretPassword", TRUE)

## creates new project.
domino.create("my-new-project")

## gets existing project from the server.
domino.get("jglodek/my-old-project")

## gets existing project from the server.
domino.get("my-old-project")

## initializes new domino project in current working directory with a given name.
domino.init("other-name")

## downloads run results from Domino server.
domino.download()

## uploads project files to Domino server.
domino.upload()

## runs main.r in the cloud with given arguments.
domino.run("main.r", "other", "console", "arguments")

## shows difference between current version and last uploaded version.
domino.diff()

## displays current run's status in the console.
domino.status()

## shows debug information
domino.debug()

## resets project defined in by current working directory
domino.reset()

## runs any of domino client command with given arguments
domino.runCommand("run my-file.r", successCallback, "failure message!")


## End(Not run)

domino.create

Description

Creates Domino project. Changes working directory to new project's one.

Usage

domino.create(projectName)

Arguments

Examples

## Not run: 
# in directory ./
domino.create("my-new-project")
# current working directory is now switched to ./my-new-project and new
project is initialized.

## End(Not run)

domino.debug

Description

Shows Domino debug information.

Usage

domino.debug()

domino.diff

Description

Shows changes between your local version of project's data, and the version uploaded to the Domino servers.

Usage

domino.diff()

domino.download

Description

Downloads the latest Domino run results to the project's folder.

Usage

domino.download()

domino.dump

Description

run dump command

Usage

domino.dump()

domino.get

Description

Downloads given project data from Domino. Changes working directory to the project's directory.

Usage

# Usage without username 
domino.get("projectName")

Arguments

Examples

## Not run: 
# in directory ./
domino.get("my-project-in-the-cloud")
# current working directory is now switched to ./my-project-in-the-cloud 
and the directory
# is filled with files from Domino server.

# The name of the project is prepended with username
    domino.get("jglodek/my-project-in-the-cloud")

## End(Not run)

domino.init

Description

Initializes new domino project in current directory. It can also set arbitrary name to the project, even if different from current directory name.

Usage

# inits a project inside current directory, with given name.
# ex. if run in ~/my_project, with "my_name" as a param,
# it will create a Domino project called my-param inside ~/my_project directory.
domino.init("projectName")

Arguments

Examples

## Not run: 
# in directory ./
domino.init("my-new-project")
# new project with name "my-new-project" is initialized inside current directory.

## End(Not run)

domino.login

Description

Logins to Domino server.

Usage

domino.login(usernameOrEmail, password,
approvalForSendingErrorReports=FALSE, host)

Arguments

Examples

## Not run: 
domino.login("jglodek", TRUE)
domino.login("jglodek","my-super-secret-password", TRUE)
domino.login("jglodek","my-super-secret-password", TRUE, "https://app.dominodatalab.com")

## End(Not run)

domino.reset

Description

Resets Domino project.

Usage

domino.reset()

domino.run

Description

Runs your project on Domino servers with given parameters.

Usage

domino.run(..., publishApiEndpoint=FALSE)

Arguments

Examples

## Not run: 
my_data <- 4
domino.run("main.R","1","my-file1.csv", my_data)
#=> Runs "domino main.R 1 my-file1.csv 4"

## End(Not run)

domino.runCommand

Description

Runs domino client command and runs success callback or shows failure message

Usage

domino.runCommand(commandAndArgs, successCallback = domino.OK,
failureMessage = "Executing the command failed", stdInput = FALSE)

Arguments

Examples

## Not run: 
success <- function() {
print("Success!")
}
domino.runCommand("run main.R 1 2 3",success, "failed to succeed")
# Runs command "run main.R 1 2 3" and 
# calls 'success' function if domino command ends successfuly.
# Prints error message  - "failed to succeed" if domino command fails.

## End(Not run)

domino.snapshot

Description

take a snapshot of your command history and workspace.

Usage

domino.snapshot(commitMessage)

Arguments

domino.status

Description

Shows status of current Domino project.

Usage

domino.status(...)

Arguments

domino.sync

Description

Synchronizes the local project copy with the server project copy, by running 'download' followed by 'upload'.

Usage

domino.sync()

domino.upload

Description

Uploads local version of Domino project files to the server.

Usage

domino.upload(commitMessage)

Arguments