R/domino-package.R

#' Package: domino \cr
#' Type:    Package  \cr
#' Version: 0.3-1 \cr
#' Date:    2017-11-22 \cr
#' License: MIT \cr
#' Author:  Jacek Glodek jacek@theiterators.com \cr
#' Maintainer: Nick Elprin nick@dominoup.com
#'
#' @title Domino Data Lab R console bindings
#' @name domino-package
#'
#' @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.
#'
#' @name domino
#' @docType package
#'
#' @keywords domino, package, dominoup
#' @references Domino Data Lab support webpage - http://help.dominodatalab.com/
#'
#'
#' @examples
#' \dontrun{
#' ## 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!")
#'
#' }
NULL

Try the domino package in your browser

Any scripts or data that you put into this service are public.

domino documentation built on May 2, 2019, 10:16 a.m.