dxR 0.40.0

appGet API wrapper

Usage

appGet(appNameOrID, alias = NULL, inputParams = emptyNamedList, jsonifyData = TRUE,
  alwaysRetry = TRUE)

Arguments

appNameOrID
An app identifier using either the name of an app ("app-name") or its full ID ("app-xxxx")
alias
If an app name is given for appNameOrID, this can be provided to specify a version or tag (if not provided, the "default" tag is used).
inputParams
Either an R object that will be converted into JSON using RJSONIO::toJSON to be used as the input to the API call. If providing the JSON string directly, you must set jsonifyData to FALSE.
jsonifyData
Whether to call RJSONIO::toJSON on inputParams to create the JSON string or pass through the value of inputParams directly. (Default is TRUE.)
alwaysRetry
Whether to always retry even when no response is received from the API server

Value

If the API call is successful, the parsed JSON of the API server response is returned (using RJSONIO::fromJSON).

Description

This function makes an API call to the /app-xxxx/get API method; it is a simple wrapper around the dxHTTPRequest function which makes POST HTTP requests to the API server.

References

API spec documentation: http://wiki.dnanexus.com/API-Specification-v1.0.0/Apps#API-method:-/app-xxxx%5B/yyyy%5D/get

See also

dxHTTPRequest