CollectionR Documentation

Collection

Description

Collection class provides interface for working with Arvados collections.

Usage

collection = Collection$new(arv, uuid)

Arguments

arv

Arvados object.

uuid

UUID of a collection.

Methods

add(content)

Adds ArvadosFile or Subcollection specified by content to the collection.

create(files)

Creates one or more ArvadosFiles and adds them to the collection at specified path.

remove(fileNames)

Remove one or more files from the collection.

move(content, destination)

Moves ArvadosFile or Subcollection to another location in the collection.

copy(content, destination)

Copies ArvadosFile or Subcollection to another location in the collection.

getFileListing()

Returns collections file content as character vector.

get(relativePath)

If relativePath is valid, returns ArvadosFile or Subcollection specified by relativePath, else returns NULL.

Examples

## Not run: 
arv <- Arvados$new("your Arvados token", "example.arvadosapi.com")
collection <- Collection$new(arv, "uuid")

createdFiles <- collection$create(c("main.cpp", lib.dll), "cpp/src/")

collection$remove("location/to/my/file.cpp")

collection$move("folder/file.cpp", "file.cpp")

arvadosFile <- collection$get("location/to/my/file.cpp")
arvadosSubcollection <- collection$get("location/to/my/directory/")

## End(Not run)