Skip to content

Commit

Permalink
Documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
ymarcon committed May 18, 2020
1 parent 4bf5e58 commit 0121fe1
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 10 deletions.
6 changes: 6 additions & 0 deletions R/datashield.aggregate.R
Expand Up @@ -9,6 +9,12 @@
#'
#' @return The result of the aggregation
#'
#' @examples
#'\dontrun{
#' # call aggregate function on server side
#' datashield.aggregate(conns, expr = quote(someFunction(D, 123)))
#'}
#'
#' @export
datashield.aggregate <- function(conns, expr, async=TRUE) {
.clearLastErrors()
Expand Down
10 changes: 5 additions & 5 deletions R/datashield.assign.R
Expand Up @@ -157,16 +157,16 @@ datashield.assign.table <- function(conns, symbol, table, variables=NULL, missin
#' @examples
#' \dontrun{
#' # assign a resource HOP
#' datashield.assign.resource(conn, symbol="D", resource="demo.HOP")
#' datashield.assign.resource(conn, symbol="rsrc", resource="demo.HOP")
#'
#' # assign the tables that are defined in the logindata ('server' and 'resource' columns are
#' # expected) data frame that is used in datashield.login() function. Connections names
#' # and server names must match.
#' datashield.assign.resource(conns, "D", logindata)
#' datashield.assign.resource(conns, "rsrc", logindata)
#'
#' # assign the resources that are defined in the provided named list. Connections names
#' # and server names must match.
#' datashield.assign.resource(conns, "D",
#' datashield.assign.resource(conns, "rsrc",
#' list(server1="datashield.CNSIM1", server2="datashield.CNSIM2"))
#' }
#' @export
Expand Down Expand Up @@ -241,8 +241,8 @@ datashield.assign.resource <- function(conns, symbol, resource, async=TRUE) {
#'
#' @examples
#' \dontrun{
#' # assign a o
#' datashield.assign.expr(o, symbol="G", expr=quote(as.numeric(D$GENDER)))
#' # assign a G symbol
#' datashield.assign.expr(conns, symbol = "G", expr = quote(as.numeric(D$GENDER)))
#' }
#' @export
datashield.assign.expr <- function(conns, symbol, expr, async=TRUE) {
Expand Down
7 changes: 7 additions & 0 deletions man/datashield.aggregate.Rd

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

4 changes: 2 additions & 2 deletions man/datashield.assign.expr.Rd

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

6 changes: 3 additions & 3 deletions man/datashield.assign.resource.Rd

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

0 comments on commit 0121fe1

Please sign in to comment.