AppsApi: Agave Apps API operations

Description Usage Format Details Arguments Methods See Also

Description

AppsApi Class

Usage

1
apps <- AppsApi$new( apiClient = ApiClient$new(), cache = AgaveCache$new() )

Format

An object of class R6ClassGenerator of length 24.

Details

An app, in the context of Agave, is an executable code available for invocation through the Agave Jobs service on a specific execution system. Put another way, an app is a piece of code that you can run on a specific system. If a single code needs to be run on multiple systems, each combination of app and system needs to be defined as an app.

Apps are language agnostic and may or may not carry with them their own dependencies. (More on bundling your app in a moment.) Any code that can be forked at the command line or submitted to a batch scheduler can be registered as an Agave app and run through the Jobs service.

The Apps service is the central registry for all Agave apps. The Apps service provides permissions, validation, archiving, and revision information about each app in addition to the usual discovery capability. The rest of this tutorial explains in detail how to register an app to the Apps service, how to manage and share apps, and what the different application scopes mean.

Read more about the Apps API in the Agave Developer's Guide

Arguments

apiClient a rAgave::ApiClient instance preconfigured to speak to the Agave Platform.

cache an rAgave::AgaveCache instance pointing to the persistent auth cache file on disk.

responseType the default object type methods of this class should return. Valid values are:

Methods

$addApp() Register and update new applications.

Usage

1
apps$addApp$listApps(naked, body, )

$addAppPermission() Grant a user permission for an application.

Usage

1
apps$addAppPermission$listApps(appId, body, naked, )

$clearAppPermissions() Deletes all permissions on an application.

Usage

1
apps$clearAppPermissions$listApps(appId, naked, )

$deleteApp() Deletes an application.

Usage

1
apps$deleteApp$listApps(appId, naked, )

$deleteAppPermission() Deletes all permissions for the given user on an application.

Usage

1
apps$deleteAppPermission$listApps(appId, username, naked, )

$getAppDetails() Get details of an application by its unique id.

Usage

1
2
apps$getAppDetails$listApps(appId, naked, search, )
apps$getAppDetails$listApps(search=list("foo"="bar"))

$getAppPermission() Get a specific user permission for an application.

Usage

1
apps$getAppPermission$listApps(appId, username, filter, naked, )

$getAppSubmissionForm() Get a submission form for the named application.

Usage

1
2
apps$getAppSubmissionForm$listApps(appId, naked, search, )
apps$getAppSubmissionForm$listApps(search=list("foo"="bar"))

$invokeAppAction() Edit an application.

Usage

1
apps$invokeAppAction$listApps(appId, body, naked, )

$listAppHistory() List the event history of this app

Usage

1
2
apps$listAppHistory$listApps(naked, appId, status, created, limit, offset, search, )
apps$listAppHistory$listApps(search=list("foo"="bar"))

$listAppPermissions() Get the permission for this application.

Usage

1
2
apps$listAppPermissions$listApps(appId, filter, naked, limit, offset, search, )
apps$listAppPermissions$listApps(search=list("foo"="bar"))

$listApps() List apps

Usage

1
2
apps$listApps$listApps(public, name, executionSystem, tags, filter, naked, limit, offset, search, )
apps$listApps$listApps(search=list("foo"="bar"))

$updateApp() Update an application.

Usage

1
apps$updateApp$listApps(appId, body, naked, )

$updateAppPermission() Add or update a user permission for an application.

Usage

1
apps$updateAppPermission$listApps(appId, username, body, naked, )

See Also

rAgave::ApiClient rAgave::Agave [rAgave::Application][rAgave::ApplicationAction][rAgave::ApplicationSummary][rAgave::HistoryEvent][rAgave::Permission]


agaveplatform/r-sdk documentation built on Sept. 22, 2018, 2:14 p.m.