Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/release-v1.0.2'
Browse files Browse the repository at this point in the history
Merge in `release-v1.0.2` back to `master`.
  • Loading branch information
swells committed Dec 15, 2015
2 parents 7adffc6 + b987d95 commit fcef4c7
Show file tree
Hide file tree
Showing 15 changed files with 84 additions and 76 deletions.
15 changes: 10 additions & 5 deletions DESCRIPTION
@@ -1,16 +1,21 @@
Package: deployrUtils
Type: Package
Title: Develop Portable R Code for Use with DeployR
Version: 1.0.1
Date: 2015-09-04
Version: 1.0.2
Date: 2015-11-30
person("Josee", "Martens", email = "jmartens@microsoft.com", role = "aut"),
person("Nick", "Riesland", email = "nicr@microsoft.com", role = "ctb"),
person("Sean", "Wells", email = "seanw@microsoft.com", role = "ctb")
person("Rich", "Calaway", email = "richcala@microsoft.com", role = "cre"))
Author: Josee Martens [aut]
Maintainer: Rich Calaway <richcala@microsoft.com>
URL: http://deployr.revolutionanalytics.com
URL: http://go.microsoft.com/fwlink/?LinkId=692163
BugReports: https://github.com/deployr/deployrUtils/issues
Description: The goal of this package 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.
Description: The goal of this package 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.
License: MIT + file LICENSE
Suggests: testthat
Suggests:
testthat
RoxygenNote: 5.0.1
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2010-2015 by Revolution Analytics Inc.
Copyright (C) 2010-2015 by Microsoft Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2010-2015 by Revolution Analytics Inc.
Copyright (C) 2010-2015 by Microsoft Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down
2 changes: 1 addition & 1 deletion NAMESPACE
@@ -1,4 +1,4 @@
# Generated by roxygen2 (4.1.1): do not edit by hand
# Generated by roxygen2: do not edit by hand

export(deployrExternal)
export(deployrInput)
Expand Down
2 changes: 1 addition & 1 deletion R/deployrExternal.R
Expand Up @@ -7,7 +7,7 @@
#'
#' When your code executes locally, the function looks for the data files in the current working directory of your R session. When your code executes remotely on the DeployR server, the function looks for the data files in the dedicated external directories configured and managed by the DeployR administrator.
#'
#' For more information on configuring or using external directories, see the \sQuote{Writing Portable R Code} document for your DeployR version on the official DeployR website (\url{http://deployr.revolutionanalytics.com/documents/dev/scientist-portable-code/}).
#' For more information on configuring or using external directories, see the \sQuote{Writing Portable R Code} document for your DeployR version on the official DeployR website (\url{http://go.microsoft.com/fwlink/?LinkId=708337}).
#'
#' @param file Required. A character string specifying a valid filename with its extension.
#' @param isPublic Optional. If \code{isPublic = NULL} or \code{isPublic = FALSE} and code is running on DeployR, then the file is assumed to be in your private user external directory. If \code{isPublic = TRUE} and code is running on DeployR, then the file is assumed to be in the public external directory. Since the usage of the public external directory is ultimately a deployment decision, please coordinate with the application developer(s) before enabling this argument.
Expand Down
2 changes: 1 addition & 1 deletion R/deployrInput.R
Expand Up @@ -8,7 +8,7 @@
#' \item{Provide client application developers with clear guidance as to which script inputs their application will be required to supply to produce meaningful output.}
#' }
#'
#' For more information on declaring your inputs, see the \sQuote{Writing Portable R Code} document for your DeployR version on the official DeployR website (\url{http://deployr.revolutionanalytics.com/documents/dev/scientist-portable-code/}).
#' For more information on declaring your inputs, see the \sQuote{Writing Portable R Code} document for your DeployR version on the official DeployR website (\url{http://go.microsoft.com/fwlink/?LinkId=708337}).
#'
#' @param content A valid JSON string configuration using the following
#' structure:
Expand Down
4 changes: 2 additions & 2 deletions R/deployrPackage.R
Expand Up @@ -4,7 +4,7 @@
#'
#' This function safeguards your R code by making certain that the necessary packages are available to your R code at runtime.
#'
#' For more information on ensuring package portability, see the \sQuote{Writing Portable R Code} document for your DeployR version on the official DeployR website (\url{http://deployr.revolutionanalytics.com/documents/dev/scientist-portable-code/}).
#' For more information on ensuring package portability, see the \sQuote{Writing Portable R Code} document for your DeployR version on the official DeployR website (\url{http://go.microsoft.com/fwlink/?LinkId=708337}).
#'
#' @details Declare the set of package dependencies using this function at the top of your script.
#'
Expand All @@ -16,7 +16,7 @@
#'
#' @param lib character vector providing the library directories where to install the packages. Recycled as needed. If missing, defaults to the first element of \code{.libPaths().}
#'
#' @param repos character vector, the base URL(s) of the repositories to use, such as the URL of a CRAN mirror (for example: \url{http://cran.revolutionanalytics.com}.) Can be \code{NULL} to install from local files (with extension \code{.tar.gz} for source packages). \cr Tip: If you develop your own private R packages and want to use them in DeployR, then we recommend storing these packages in a local CRAN repository that is reachable by the DeployR server. For more on setting up a local package repository, visit: \url{http://cran.r-project.org/doc/manuals/r-release/R-admin.html}.
#' @param repos character vector, the base URL(s) of the repositories to use, such as the URL of a CRAN mirror (for example: \url{http://go.microsoft.com/fwlink/?LinkId=708336}.) Can be \code{NULL} to install from local files (with extension \code{.tar.gz} for source packages). \cr Tip: If you develop your own private R packages and want to use them in DeployR, then we recommend storing these packages in a local CRAN repository that is reachable by the DeployR server. For more on setting up a local package repository, visit: \url{http://cran.r-project.org/doc/manuals/r-release/R-admin.html}.
#'
#' @param ... additional arguments to pass to \code{\link{install.packages}} function.
#'
Expand Down
4 changes: 2 additions & 2 deletions R/deployrUtils.R
Expand Up @@ -11,8 +11,8 @@
#'
#' @docType package
#' @name deployrUtils
#' @author Revolution Analytics
#' @references \url{http://deployr.revolutionanalytics.com/}
#' @author Microsoft Corporation
#' @references \url{http://go.microsoft.com/fwlink/?LinkId=692163}
#'
#' \url{https://github.com/deployr/deployrUtils}
NULL
8 changes: 4 additions & 4 deletions README.md
Expand Up @@ -4,7 +4,7 @@

## 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](https://deployr.revolutionanalytics.com) server environment. They are package portability, input portability, and portable access to data files.
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](http://go.microsoft.com/fwlink/?LinkId=692163) 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.

Expand Down Expand Up @@ -70,12 +70,12 @@ df <- RxXdfData(deployrExternal("data.xdf"))

**Issues:**

Post an issue at https://github.com/deployr/deployrUtils/issues
[Post an issue](https://github.com/deployr/deployrUtils/issues)

**Website:**

Learn more at http://deployr.revolutionanalytics.com/documents/dev/scientist-portable-code/
[Learn more](http://go.microsoft.com/fwlink/?LinkId=708337)

**Made by:**

Revolution Analytics, wholly owned by Microsoft
Microsoft Corporation
9 changes: 5 additions & 4 deletions man/deployrExternal.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

71 changes: 36 additions & 35 deletions man/deployrInput.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fcef4c7

Please sign in to comment.