rPlant (version 2.16)

ListApps: Deployed applications

Description

Functions for listing applications deployed in the iPlant software infrastructure and information about them.

Usage

ListApps(description=FALSE, print.curl=FALSE, suppress.Warnings = FALSE)
GetAppInfo(application, return.json=FALSE, print.curl=FALSE)

Arguments

application

name of DE application

description

when the description=TRUE, then the ListApps function will include a brief description of the app, default = FALSE

return.json

optional screen output that displays all of the results from the api, default = FALSE

print.curl

Prints the curl statement that can be used in the terminal, if curl is installed on your computer

suppress.Warnings

This will turn off the warnings, will speed up run time. Use with caution, if the inputs are incorrect they will not be caught.

Value

The function ListApps returns a list of sorted applications and a short description. The applications are all verified to be public applications and they are the newest version. All of the public applications in that list can be used in the SubmitJob function. The GetAppInfo function gives critical information on the application that is needed in the SubmitJob function. A list of information is outputted. The first element gives a short description of the application. The second element in the list gives basic information on the application including is it a public application and if it is the newest version. Both are important information. If the application is a private application it can only be run by the person who submitted the application to the Agave API, and clearly you want to run the newest version of the public application.The third element in the list the matrix outputted gives four columns of information. The first column, labeled 'kind, tells the "input", sometimes the "output" and "parameters" from the application. The second column, labeled id, give the name of the "input", etc. For example, GetAppInfo("velveth-1.2.07u1")$Information, the 'kind' column states there are six inputs for this app, and the 'id' column the names of those inputs are "reads5","reads3", etc. There are also eight parameters for the app, the paramters are format2, etc. The third column in the matrix is 'fileType/value. For the input this tells the file type which is important because if the wrong fileType is inputted into the function, then the function will not work. For the parameters the third column contains the type of input necessary for the parameters, common ones are string, boolean, etc. The last column gives brief details on each input.

See Also

SubmitJob

Examples

	## Not run: ListApps()
	## Not run: GetAppInfo("Muscle-3.8.32u4")
	## Not run: GetAppInfo("velveth-1.2.07u1")