TransformsApi: Agave Transforms API operations

Description Usage Format Details Arguments Methods See Also

Description

TransformsApi Class

Usage

1
transforms <- TransformsApi$new( apiClient = ApiClient$new(), cache = AgaveCache$new() )

Format

An object of class R6ClassGenerator of length 24.

Details

Read more about the Transforms 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

$asyncTransform() Transform a file and stage it to a specified location.

Usage

1
transforms$asyncTransform$listTransforms(transformId, owner, filePath, body, naked, )

$getTransform() Find the transform of the given uuid

Usage

1
2
transforms$getTransform$listTransforms(transformId, naked, search, )
transforms$getTransform$listTransforms(search=list("foo"="bar"))

$listTransforms() List and search for transforms

Usage

1
2
transforms$listTransforms$listTransforms(naked, name, version, limit, offset, tags, search, )
transforms$listTransforms$listTransforms(search=list("foo"="bar"))

$syncTransform() Transform a file and download it directly.

Usage

1
transforms$syncTransform$listTransforms(transformId, owner, filePath, body, naked, )

See Also

rAgave::ApiClient rAgave::Agave rAgave::Transform


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